arcgis-maps-kotlin/com.arcgismaps.utilitynetworks/UtilityNamedTraceConfiguration

UtilityNamedTraceConfiguration

class UtilityNamedTraceConfiguration

A set of predefined trace options that can be used by UtilityTraceParameters to simplify configuring and running a trace operation. Named trace configurations are created in the utility network and allow clients to perform trace analytics without needing to understand the data model. Applications can simply allow the user to choose from a set of named trace configurations that provide tracing capabilities. The set can be configured for different workflows, and a single application can be used by multiple customers and even across multiple problem domains.

Since

200.1.0

See also

ArcGISMap.getNamedTraceConfigurationsFromUtilityNetwork

(UtilityNetwork)

UtilityNetwork.queryNamedTraceConfigurations

(UtilityNamedTraceConfigurationQueryParameters)

Properties

val creator: String

The creator of the named trace configuration. The creator will be the active portal user when the named trace configuration was created.

val description: String

The description of the named trace configuration.

val globalId: Guid

The global ID of the named trace configuration.

minimumStartingLocations

val minimumStartingLocations: UtilityMinimumStartingLocations

The minimum number of starting locations required for this trace type (e.g. shortest path trace requires 2).

val name: String

The name of the named trace configuration.

val resultTypes: List<UtilityTraceResultType>

The result types returned by this named trace configuration.

val tags: List<String>

The user tags of the named trace configuration.

val traceType: UtilityTraceType

The UtilityTraceType used by the named trace configuration.

Functions

getDefaultTraceConfiguration

fun getDefaultTraceConfiguration(): UtilityTraceConfiguration

Gets a copy of the UtilityTraceConfiguration defined for this UtilityNamedTraceConfiguration.