UtilityNetwork class final
A utility network.
This is the central class for utility network schema information and tracing. UtilityNetwork follows the Loadable pattern. When it loads, it is populated with the utility network schema. This class provides methods to create UtilityElement objects for the UtilityNetwork.
- Implemented types
- Mixed-in types
Constructors
- UtilityNetwork(ServiceGeodatabase serviceGeodatabase)
-
Creates a utility network from the specified service geodatabase that
contains it.
factory
Properties
- definition → UtilityNetworkDefinition?
-
The definition of the UtilityNetwork.
no setter
- dirtyAreaTable → ArcGISFeatureTable?
-
The dirty area table of the UtilityNetwork.
no setter
- geodatabase → Geodatabase?
-
The Geodatabase that contains this UtilityNetwork.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- loadError → ArcGISException?
-
The load error.
no setterinherited
- loadStatus → LoadStatus
-
The load status.
no setterinherited
- name → String
-
The name of the UtilityNetwork.
no setter
-
onLoadStatusChanged
→ Stream<
LoadStatus> -
A stream that reports changes to the LoadStatus.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serviceGeodatabase → ServiceGeodatabase?
-
The ServiceGeodatabase of the UtilityNetwork.
no setter
- uri → Uri?
-
The URI of the UtilityNetwork.
no setter
Methods
-
addAssociation(
UtilityAssociation association) → Future< void> - Adds an association between two utility elements in this utility network.
-
canAddAssociation(
UtilityAssociation association) → Future< bool> - Checks if the utility association can be added to the utility network.
-
canAddAssociationTypeAndElements(
{required UtilityAssociationType associationType, required UtilityElement fromElement, required UtilityElement toElement}) → Future< bool> - Checks if a utility association with the specified type between the specified utility elements can be added to the utility network.
-
cancelLoad(
) → void -
Cancels loading metadata for the object.
inherited
-
canDeleteAssociations(
) → bool - Checks whether associations can be deleted.
-
createElement(
{required ArcGISFeature arcGISFeature, UtilityTerminal? terminal}) → UtilityElement - Creates an UtilityElement from a feature and an optional UtilityTerminal.
-
createElementWithAssetType(
UtilityAssetType assetType, {required Guid globalId, UtilityTerminal? terminal}) → UtilityElement - Creates an UtilityElement from an UtilityAssetType, a GlobalID, and an optional UtilityTerminal.
-
deleteAssociation(
UtilityAssociation association) → Future< void> - Deletes an association from this utility network.
-
deleteAssociations(
List< UtilityAssociation> associations) → Future<void> - Deletes a collection of associations from this utility network.
-
getAssociations(
{required UtilityElement element, UtilityAssociationType? type}) → Future< List< UtilityAssociation> > - Returns a list of all UtilityAssociation objects of type UtilityAssociationType present in the geodatabase for a given UtilityElement.
-
getAssociationsWithEnvelope(
Envelope extent, {UtilityAssociationType? type}) → Future< List< UtilityAssociation> > - Returns a list of all UtilityAssociation objects (with their geometry) of type UtilityAssociationType present in the geodatabase for a given Envelope.
-
getFeaturesForElements(
List< UtilityElement> elements) → Future<List< ArcGISFeature> > - Gets a collection of loaded ArcGISFeature objects that each correspond to one of a collection of UtilityElement objects.
-
getState(
) → Future< UtilityNetworkState> - Returns an UtilityNetworkState that represents the current state of the utility network.
-
load(
) → Future< void> -
Loads the metadata for the object asynchronously.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
queryNamedTraceConfigurations(
{UtilityNamedTraceConfigurationQueryParameters? queryParameters}) → Future< List< UtilityNamedTraceConfiguration> > - Returns a list of UtilityNamedTraceConfiguration from the utility network.
-
retryLoad(
) → Future< void> -
Loads or retries loading metadata for the object asynchronously.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
trace(
UtilityTraceParameters traceParameters) → Future< List< UtilityTraceResult> > - Begins a trace with the supplied UtilityTraceParameters.
-
validateNetworkTopology(
{required Envelope extent, GeoprocessingExecutionType geoprocessingExecutionType = GeoprocessingExecutionType.synchronousExecute}) → UtilityNetworkValidationJob - Returns a job that when started will validate the utility network topology within the provided extent.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited