Class UtilityElement
- java.lang.Object
-
- com.esri.arcgisruntime.utilitynetworks.UtilityElement
-
public final class UtilityElement extends java.lang.Object
Defines a feature in the utility network.- Since:
- 100.6.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UtilityAssetGroup
getAssetGroup()
Gets the asset group of the feature represented by this utility element.UtilityAssetType
getAssetType()
Gets the asset type of the feature represented by this utility element.double
getFractionAlongEdge()
Gets how far the starting point or barrier is along an edge in the utility network feature.java.util.UUID
getGlobalId()
Gets the global ID of the feature represented by this utility element.UtilityNetworkSource
getNetworkSource()
Gets the network source that contains the feature represented by this utility element.long
getObjectId()
Gets the object ID of the feature represented by this utility element.UtilityTerminal
getTerminal()
Gets theUtilityTerminal
of the feature represented by this utility network feature.boolean
isValid()
Indicates whether or not the UtilityElement has complete data available.void
setFractionAlongEdge(double fractionAlongEdge)
Sets how far the starting point or barrier is along an edge in the utility network feature.void
setTerminal(UtilityTerminal utilityTerminal)
Sets the terminal of the feature represented by this utility element.
-
-
-
Method Detail
-
getAssetGroup
public UtilityAssetGroup getAssetGroup()
Gets the asset group of the feature represented by this utility element.- Returns:
- the asset group
- Since:
- 100.6.0
-
getAssetType
public UtilityAssetType getAssetType()
Gets the asset type of the feature represented by this utility element.- Returns:
- the asset type
- Since:
- 100.6.0
-
getGlobalId
public java.util.UUID getGlobalId()
Gets the global ID of the feature represented by this utility element.- Returns:
- the global ID
- Since:
- 100.6.0
-
getNetworkSource
public UtilityNetworkSource getNetworkSource()
Gets the network source that contains the feature represented by this utility element.- Returns:
- the network source
- Since:
- 100.6.0
-
getObjectId
public long getObjectId()
Gets the object ID of the feature represented by this utility element. Only valid on results from a tracing operation, or with utility elements that are created from aArcGISFeature
.- Returns:
- the object ID or -1 if invalid
- Since:
- 100.6.0
-
getFractionAlongEdge
public double getFractionAlongEdge()
Gets how far the starting point or barrier is along an edge in the utility network feature. Valid values are from 0.0 to 1.0. Only valid when theglobal ID
points to an edge feature that is an input to a tracing operation.- Returns:
- the fraction along edge value
- Since:
- 100.6.0
-
getTerminal
public UtilityTerminal getTerminal()
Gets theUtilityTerminal
of the feature represented by this utility network feature. Only valid whengetGlobalId()
returns a device feature.- Returns:
- the terminal or null if none
- Since:
- 100.6.0
-
setFractionAlongEdge
public void setFractionAlongEdge(double fractionAlongEdge)
Sets how far the starting point or barrier is along an edge in the utility network feature. Valid values are from 0.0 to 1.0. Only valid when theglobal ID
points to an edge feature that is an input to a tracing operation.- Parameters:
fractionAlongEdge
- fraction along edge value- Throws:
java.lang.IllegalArgumentException
- if fractionAlongEdge is out of range from 0.0 to 1.0- Since:
- 100.6.0
-
setTerminal
public void setTerminal(UtilityTerminal utilityTerminal)
Sets the terminal of the feature represented by this utility element.Only valid when the
getGlobalId()
refers to a device feature.- Parameters:
utilityTerminal
- the utility terminal, or null for none- Since:
- 100.7.0
-
isValid
public boolean isValid()
Indicates whether or not the UtilityElement has complete data available.When taking an
UtilityNetwork
offline, some of the data can be filtered out to limit the size of the data. This may leave some elements in an incomplete state. For example, one element of an association may be included in the offline dataset while the other element may not.When an element is incomplete, the following properties should not be used:
WhenisValid()
is false, theUtilityAssetType
is assumed to have aUtilityAssociationDeletionSemantics
ofRESTRICTED
.- Returns:
- indicates whether or not the UtilityElement has complete data available
- Since:
- 100.11.0
-
-