ArcGIS Developers

UtilityAssociation Class

class Esri::ArcGISRuntime::UtilityAssociation

A connectivity, containment, or structural attachment association. More...

Header: #include <UtilityAssociation>
Since: Esri::ArcGISRuntime 100.7
Inherits: Esri::ArcGISRuntime::Object

This class was introduced in Esri::ArcGISRuntime 100.7.

Public Functions

virtual ~UtilityAssociation() override
Esri::ArcGISRuntime::UtilityAssociationType associationType() const
double fractionAlongEdge() const
Esri::ArcGISRuntime::UtilityElement *fromElement() const
Esri::ArcGISRuntime::Geometry geometry() const
QUuid globalId() const
bool isContainmentVisible() const
Esri::ArcGISRuntime::UtilityElement *toElement() const

Detailed Description

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.

Member Function Documentation

[override virtual] UtilityAssociation::~UtilityAssociation()


Esri::ArcGISRuntime::UtilityAssociationType UtilityAssociation::associationType() const

Returns the UtilityAssociationType of this association.

double UtilityAssociation::fractionAlongEdge() const

Returns 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).

If this association represents UtilityAssociationType::JunctionEdgeObjectConnectivityToSide, the value will be 0.0, if UtilityAssociationType::JunctionEdgeObjectConnectivityMidspan, the value will be between 0.0 and 1.0, and if UtilityAssociationType::JunctionEdgeObjectConnectivityFromSide, the value will be 1.0.

The default value is 0.0.

This function was introduced in Esri::ArcGISRuntime 100.10.

Esri::ArcGISRuntime::UtilityElement *UtilityAssociation::fromElement() const

Returns the first participant in a UtilityAssociation.

If this is a containment association, this property represents the container. If this is a structural attachment association, this property represents the structure.

Esri::ArcGISRuntime::Geometry UtilityAssociation::geometry() const

Returns 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 of UtilityAssociation objects returned by UtilityNetwork::associations(extent) or UtilityNetwork::associations(extent, type).

This function was introduced in Esri::ArcGISRuntime 100.8.

QUuid UtilityAssociation::globalId() const

Returns the global ID of the association.

bool UtilityAssociation::isContainmentVisible() const

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

Esri::ArcGISRuntime::UtilityElement *UtilityAssociation::toElement() const

Returns 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.

Feedback on this topic?