UtilityAssociation

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

200.1.0

Constructors

Link copied to clipboard
constructor(associationType: UtilityAssociationType, fromElement: UtilityElement, toElement: UtilityElement)

Creates an association with the specified type between the specified utility elements. Use this constructor if the association type does not need to specify a different value for:

constructor(associationType: UtilityAssociationType, fromElement: UtilityElement, toElement: UtilityElement, isContainmentVisible: Boolean)

Creates an association with the specified type between the specified utility elements with UtilityAssociation.isContainmentVisible value. This constructor is typically used when creating UtilityAssociationType.Containment association.

constructor(associationType: UtilityAssociationType, fromElement: UtilityElement, toElement: UtilityElement, fractionAlongEdge: Double)

Creates an association with the specified type between the specified utility elements with the UtilityAssociation.fractionAlongEdge value. This constructor is typically used when creating UtilityAssociationType.JunctionEdgeObjectConnectivityMidspan association.

Properties

Link copied to clipboard
Link copied to clipboard

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) and 1.0 (the edge's end point).

Link copied to clipboard

The first participant in an UtilityAssociation. If this is a containment association, this property represents the container. If this is a structural attachment association, this property represents the structure.

Link copied to clipboard

The geometry of this UtilityAssociation. This geometry represents the connection between UtilityAssociation.fromElement and UtilityAssociation.toElement. This property is valid only on connectivity and structural attachment UtilityAssociation objects returned by UtilityNetwork.getAssociations or UtilityNetwork.getAssociations.

Link copied to clipboard

The global ID of the association.

Link copied to clipboard

If this UtilityAssociation represents a containment association, returns whether the containment is visible.

Link copied to clipboard

The second participant in an association. If this is a containment association, this property represents the content. If this is a structural attachment association, this property represents the attached item.