Class UtilityAssociation
- java.lang.Object
-
- com.esri.arcgisruntime.utilitynetworks.UtilityAssociation
-
public final class UtilityAssociation extends java.lang.Object
A connectivity, containment, or structural attachment association.Associations are an integral part of network topology. Connectivity associations allow connectivity between two junctions that don't have geometric coincidence (are not in the same location). Structural attachment associations allow modeling equipment attached to structures. Containment associations allow modeling containment of features within other features. Network traces make use of associations. Associations are defined using two
UtilityElement
objects.- Since:
- 100.7.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UtilityAssociationType
getAssociationType()
Gets theUtilityAssociationType
of this association.double
getFractionAlongEdge()
Gets the relative location along the non-spatial edge where the junction is (logically) located.UtilityElement
getFromElement()
Gets the first participant in aUtilityAssociation
.Geometry
getGeometry()
Gets the geometry of this UtilityAssociation.java.util.UUID
getGlobalId()
Gets the global ID of the association.UtilityElement
getToElement()
Gets the second participant in aUtilityAssociation
.boolean
isContainmentVisible()
If thisUtilityAssociation
represents a containment association, returns whether the containment is visible.
-
-
-
Method Detail
-
getAssociationType
public UtilityAssociationType getAssociationType()
Gets theUtilityAssociationType
of this association.- Returns:
- the utility association type of this association
- Since:
- 100.7.0
-
getGeometry
public Geometry getGeometry()
Gets the geometry of this UtilityAssociation.This geometry represents the connection between mFromElement and mToElement. This property is valid only on connectivity and structural attachment UtilityAssociation objects returned by
UtilityNetwork.getAssociationsAsync(Envelope)
orUtilityNetwork.getAssociationsAsync(Envelope, UtilityAssociationType)
.- Returns:
- the geometry of this UtilityAssociation
- Since:
- 100.8.0
-
getFractionAlongEdge
public double getFractionAlongEdge()
Gets the relative location along the non-spatial edge where the junction is (logically) located.If this is a junction to a non-spatial edge connectivity association, this property represents how far the junction is located along the non-spatial edge, from 0.0 (the edge's start point) to 1.0 (the edge's end point).
If this association represents
UtilityAssociationType.JUNCTION_EDGE_OBJECT_CONNECTIVITY_TO_SIDE
, the value will be 0.0, ifUtilityAssociationType.JUNCTION_EDGE_OBJECT_CONNECTIVITY_MIDSPAN
, the value will be between 0.0 and 1.0, and ifUtilityAssociationType.JUNCTION_EDGE_OBJECT_CONNECTIVITY_FROM_SIDE
, the value will be 1.0.The default value is 0.0.
- Returns:
- the relative location along the non-spatial edge where the junction is (logically) located
- Since:
- 100.10.0
-
getFromElement
public UtilityElement getFromElement()
Gets the first participant in aUtilityAssociation
.If this is a containment association, this property represents the container. If this is a structural attachment association, this property represents the structure.
- Returns:
- the first participant in a utility association
- Since:
- 100.7.0
-
getToElement
public UtilityElement getToElement()
Gets the second participant in aUtilityAssociation
.If this is a containment association, this property represents the content. If this is a structural attachment association, this property represents the attached item.
- Returns:
- the second participant in a utility association
- Since:
- 100.7.0
-
getGlobalId
public java.util.UUID getGlobalId()
Gets the global ID of the association.- Returns:
- the global ID
- Since:
- 100.7.0
-
isContainmentVisible
public boolean isContainmentVisible()
If thisUtilityAssociation
represents a containment association, returns whether the containment is visible.- Returns:
- true if the utility association represents a containment association and the containment is visible, false otherwise
- Since:
- 100.7.0
-
-