Class UtilityTraceParameters
- Since:
- 100.6.0
-
Constructor Summary
ConstructorDescriptionUtilityTraceParameters
(UtilityNamedTraceConfiguration namedTraceConfiguration, Iterable<UtilityElement> startingLocations) Constructs a new UtilityTraceParameters from a pre-defined trace options with the supplied starting locations.UtilityTraceParameters
(UtilityTraceType utilityTraceType, Iterable<UtilityElement> startingLocations) Creates a trace parameters object with a particular trace type and starting locations. -
Method Summary
Modifier and TypeMethodDescriptionGets a mutable list of barriers.Gets the collection of filter barriers.Gets a mutable list of trace parameters' result types.Gets a mutable list of trace parameters' starting locations.Gets the complete collection of trace options.Gets the trace parameters' trace type.void
setTraceConfiguration
(UtilityTraceConfiguration utilityTraceConfiguration) Sets the complete collection of trace options.
-
Constructor Details
-
UtilityTraceParameters
public UtilityTraceParameters(UtilityTraceType utilityTraceType, Iterable<UtilityElement> startingLocations) Creates a trace parameters object with a particular trace type and starting locations.- Parameters:
utilityTraceType
- the type of trace to performstartingLocations
- the starting locations to begin the trace at- Throws:
IllegalArgumentException
- if utilityTraceType is nullIllegalArgumentException
- if startingLocations is null- Since:
- 100.6.0
-
UtilityTraceParameters
public UtilityTraceParameters(UtilityNamedTraceConfiguration namedTraceConfiguration, Iterable<UtilityElement> startingLocations) Constructs a new UtilityTraceParameters from a pre-defined trace options with the supplied starting locations.- Parameters:
namedTraceConfiguration
- theUtilityNamedTraceConfiguration
from which the UtilityTraceParameters object is generated.startingLocations
- the collection of starting locations- Throws:
IllegalArgumentException
- if namedTraceConfiguration is nullIllegalArgumentException
- if startingLocations is null- Since:
- 100.11.0
- See Also:
-
-
Method Details
-
getBarriers
Gets a mutable list of barriers. Initially it is empty. AddUtilityElement
to it to specify barriers.- Returns:
- a mutable list of UtilityElements that specify the barriers
- Since:
- 100.6.0
-
getFilterBarriers
Gets the collection of filter barriers.A regular barrier, specified by
getBarriers()
, prevents traversal which, when used with subnetwork-based traces, can prevent traversal to the subnetwork controller. LikeUtilityTraceConfiguration.getFilter()
, filter barriers are evaluated in the second pass of a trace. Therefore, it can restrict the result set without impacting the ability to find subnetwork controllers from starting points.One example of where filter barriers can be used is in the gas distribution domain. Filter barriers can be used to simulate the location of a squeeze-off when executing a valve isolation trace. The user can place a filter barrier at the proposed location of the squeeze-off and then verify its impact using a trace.
- Returns:
- a mutable list of filter barriers
- Since:
- 100.10.0
-
getResultTypes
Gets a mutable list of trace parameters' result types.The list is pre-populated with the default of
UtilityTraceResult.Type.ELEMENTS
. This list corresponds to theUtilityTraceResult
list returned byUtilityNetwork.traceAsync(UtilityTraceParameters)
.- Returns:
- a mutable list of result types
- Since:
- 100.6.0
-
getStartingLocations
Gets a mutable list of trace parameters' starting locations. Initially it is empty. AddUtilityElement
to it to specify starting locations. A starting point is set of network features to define the location in the network where a trace begins. All utility network traces require that one or more starting points are defined.- Returns:
- a mutable list of UtilityElements that specify the starting locations
- Since:
- 100.6.0
-
getTraceType
Gets the trace parameters' trace type.- Returns:
- the trace type
- Since:
- 100.6.0
-
getTraceConfiguration
Gets the complete collection of trace options.- Returns:
- the complete collection of trace options or null if none (for example when using a straight connected trace)
- Since:
- 100.7.0
-
setTraceConfiguration
Sets the complete collection of trace options.- Parameters:
utilityTraceConfiguration
- the new value for trace configuration or null if none (for example when using a straight connected trace)- Since:
- 100.7.0
-