The second-level categorization of a UtilityNetworkSource. More...
| Header: | #include <UtilityAssetType.h> |
| Since: | Esri::ArcGISRuntime 100.6 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| virtual | ~UtilityAssetType() override |
| Esri::ArcGISRuntime::UtilityAssociationDeletionSemantics | associationDeletionSemantics() const |
| Esri::ArcGISRuntime::UtilityAssociationRole | associationRole() const |
| QList<Esri::ArcGISRuntime::UtilityCategory *> | categories() const |
| int | code() const |
| Esri::ArcGISRuntime::UtilityContainerSplitPolicy | containerSplitPolicy() const |
| double | containerViewScale() const |
| Esri::ArcGISRuntime::UtilityConnectivityPolicy | linearConnectivityPolicy() const |
| QString | name() const |
| Esri::ArcGISRuntime::UtilityTerminalConfiguration * | terminalConfiguration() const |
Detailed Description
UtilityAssetType is the second-level categorization of a UtilityNetworkSource. (UtilityAssetGroup is the first-level categorization.)
Examples of utility network asset types include:
- The UtilityAssetType for a transformer UtilityAssetGroup in an electric distribution domain network could be StepTransformer, PowerTransformer, or DistributionTransformer.
- The UtilityAssetType for a line feature class in a water distribution domain network could be PVCPipe, ClayPipe, or CastIronPipe.
Relevant samples:
- Configure subnetwork trace: Get a server-defined trace configuration for a given tier and modify its traversability scope, add new condition barriers and control what is included in the subnetwork trace result.
- Create load report: Create a simple electric distribution report that displays the count of customers and total load per phase by tracing downstream from a given point.
- Trace utility network: Discover connected features in a utility network using connected, subnetwork, upstream, and downstream traces.
Member Function Documentation
[override virtual] UtilityAssetType::~UtilityAssetType ()
Destructor.
[since Esri::ArcGISRuntime 100.12] Esri::ArcGISRuntime::UtilityAssociationDeletionSemantics UtilityAssetType::associationDeletionSemantics () const
Returns the update applied to UtilityAssociation objects when deleting an object of this UtilityAssetType.
This determines the behavior that occurs when attempting to delete features with this asset type.
This function was introduced in Esri::ArcGISRuntime 100.12.
Esri::ArcGISRuntime::UtilityAssociationRole UtilityAssetType::associationRole () const
Returns the associationRole of the UtilityAssetType.
This property indicates whether the UtilityAssetType can be a container, a structure, or neither.
QList<Esri::ArcGISRuntime::UtilityCategory *> UtilityAssetType::categories() const
Returns the list of UtilityCategory objects.
This is a collection of system-provided network categories that incorporate semantics of the utility network for subnetwork management and tracing operations.
int UtilityAssetType::code() const
Returns the attribute domain value code of the UtilityAssetType.
[since Esri::ArcGISRuntime 200.6] Esri::ArcGISRuntime::UtilityContainerSplitPolicy UtilityAssetType::containerSplitPolicy () const
Returns the UtilityContainerSplitPolicy supported by this asset type.
UtilityContainerSplitPolicy is applicable only to edge features with UtilityAssociationRole::Container role in UtilityAssociationType::Containment associations. It determines whether the content features are split if the container is split.
This function was introduced in Esri::ArcGISRuntime 200.6.
double UtilityAssetType::containerViewScale () const
Returns the container view scale of the UtilityAssetType
If the utility asset type is a point container, this property is the appropriate display scale (zoom level) for displaying the container when it is opened. For other utility asset types, this property defaults to 0.0.
[since Esri::ArcGISRuntime 200.6] Esri::ArcGISRuntime::UtilityConnectivityPolicy UtilityAssetType::linearConnectivityPolicy () const
Returns the UtilityConnectivityPolicy supported by this asset type.
UtilityConnectivityPolicy is applicable only to edge features. It determines whether connectivity for this asset type can be established at any vertex or only at end points.
This function was introduced in Esri::ArcGISRuntime 200.6.
QString UtilityAssetType::name() const
Returns the name of the UtilityAssetType.
Esri::ArcGISRuntime::UtilityTerminalConfiguration *UtilityAssetType::terminalConfiguration () const
Returns the terminal configuration of the UtilityAssetType.
Only asset types whose network source is UtilityNetworkSourceUsageType::device can have a terminal configuration.