Work with utility elements

An array of analysis Analysis is a systematic examination of a problem that provides new information. Learn more and tracing options usually begin with or include a utility element A utility element is an entity in a utility network that corresponds to a feature or a part of a feature (for example, a terminal inside a device). Learn more in the result. This element corresponds to a network feature A feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes. Learn more or object that contains additional information such as a terminal A terminal represents logical ports, entries, or exit locations on a single device or junction object within a utility network. Each port can flow in or out. Each device can contain many terminals, all of which can be interconnected. Learn more or fraction along value that affects the analysis. For example, the utility element’s terminal may limit the number of connectivity associations An association is a relationship between two elements that is reflected in a utility network topology. Learn more or change the direction of a trace A trace is an action that analyzes the paths in a utility network and returns features based on connectivity or traversability from the specified starting points. Learn more , while its fraction along value may return a partial geometry A geometry is a geometric shape, such as a point, polyline, or polygon, that contains one or more coordinates and a spatial reference. Learn more from a trace.

This utility element may be created from a feature or asset type An asset type is a class that refines a utility element's classification within an asset group. For example, a power transformer is an asset type of the transformer asset group within an electric device network. Learn more with a global id. The feature may be a result of a query or identify Identify is a query based on a point on a map or scene that is used to find feature, graphic, or raster cell data. Learn more operation on a layer A layer is a reference to a collection of geographic data that is used to access and display data. The data for layers are typically provided by the basemap layer service and data services. Learn more or table A table is a non-spatial dataset in a feature service. All records in a table share the same set of fields. Learn more that is part of the utility network A utility network is a feature service that represents a utility system, such as water, gas, or electricity. A utility network provides the capabilities to visualize, edit, and analyze utility assets and data. Learn more .

Utility element from a feature

You may query for a specific feature using any of its fields or geometry or interactively identify a feature in a map view A map view is a user interface that displays map layers and graphics in 2D. It controls the area (extent) of the map that is visible and supports user interactions such as pan and zoom. Learn more . When using identify Identify is a query based on a point on a map or scene that is used to find feature, graphic, or raster cell data. Learn more , the feature may be found in the GeoElement list immediately under IdentifyLayerResult when part of a FeatureLayer or from sublayerResults when part of a SubtypeFeatureLayer.

        val queryParameters = QueryParameters().apply {
            whereClause = "GlobalId like '{BBF6A59A-C5CE-468A-8DFD-6198F5F3A99E}'"
        }
        val queryResult = featureTable.queryFeatures(queryParameters).getOrElse { error ->
            return logErr("Error querying features: ${error.message}")
        }
        val feature = queryResult.first()

        val identifyLayerResult = mapViewProxy.identify(
            layer = distributionLineFeatureLayer,
            screenCoordinate = screenCoordinate,
            tolerance = 10.dp,
            returnPopupsOnly = false
        ).getOrElse { error ->
            return showError(error.message.toString())
        }

        // Identify the first feature of the feature layer.
        val firstFeatureLayerFeature = identifyLayerResult.geoElements.first() as ArcGISFeature

        // Get the first sublayer from the sublayerResults. Then identify the first feature in the sublayer.
        if (identifyLayerResult.sublayerResults.isNotEmpty()) {
            val firstSublayerResult = identifyLayerResult.sublayerResults.first()
            val firstSublayerFeature = firstSublayerResult.geoElements.first() as ArcGISFeature

        }

            firstSublayerFeature.load().onFailure {
                return showError("Failed to load feature.")
            }

            // Create a utility element for the feature.
            val utilityElement: UtilityElement = utilityNetwork.createElementOrNull(firstSublayerFeature)
                ?: return showError("Failed to create a utility element.")

Utility element from an asset type

An asset type An asset type is a class that refines a utility element's classification within an asset group. For example, a power transformer is an asset type of the transformer asset group within an electric device network. Learn more can come from another utility element A utility element is an entity in a utility network that corresponds to a feature or a part of a feature (for example, a terminal inside a device). Learn more or be derived from a feature in the utility network, except from a subnet line table that does not have an asset type. You can use the feature’s table name to get its network source A network source is a feature table whose features comprise one of a utility network's datasets. Learn more . Use the network source and the feature’s subtype to get its asset group An asset group is the main classification of a utility element. Each asset group is then divided into a collection of asset types. Learn more . From the asset group, you can select an asset type by name or code.

        // Get the asset type from an element.
        val assetType = otherElement.assetType
        // Make a new utility element from the asset type and global ID.
        val element = utilityNetwork.createElementOrNull(
            assetType = assetType,
            globalId = globalId
        )

        // Get the network source with the specified name.
        val tableName = feature.featureTable?.tableName.toString()
        val networkSource =
            utilityNetwork.definition?.getNetworkSource(networkSourceName = tableName)
                ?: return showError("Failed to get the network source using feature table name.")
        // Get the asset group with the subtype name.
        val featureSubTypeName = feature.getFeatureSubtype()?.name
            ?: return showError("Feature has no subtype.")
        val assetGroup = networkSource.getAssetGroup(featureSubTypeName)
            ?: return showError("Failed to get the asset group")

        // Get an asset type from a feature's asset type code.
        val assetTypeCode = feature.attributes["ASSETTYPE"] as Short
        val featureAssetType = assetGroup.assetTypes.first { utilityAssetType ->
            utilityAssetType.code == assetTypeCode.toInt()
        }
        // Make a new utility element with the feature's asset type.
        val element = utilityNetwork.createElementOrNull(
            assetType = featureAssetType,
            globalId = globalId
        )

        // Get the asset type by name.
        val networkSource =
            utilityNetwork.definition?.getNetworkSource(networkSourceName = "Electric Distribution Device")
                ?: return showError("Failed to get network source by name.")
        val assetGroup = networkSource.getAssetGroup(assetGroupName = "Service Point")
            ?: return showError("Failed to get asset group by name.")
        val lowVoltageAssetType = assetGroup.getAssetType(name = "Single Phase Low Voltage Meter")
            ?: return showError("Failed to get asset type by name.")
        // Make a new utility element with the low voltage asset type.
        val element = utilityNetwork.createElementOrNull(
            assetType = lowVoltageAssetType,
            globalId = globalId
        )

Utility element properties

A terminal is required when a UtilityElement that supports more than one terminal A terminal represents logical ports, entries, or exit locations on a single device or junction object within a utility network. Each port can flow in or out. Each device can contain many terminals, all of which can be interconnected. Learn more is used in a trace and optional when used to get associations An association is a relationship between two elements that is reflected in a utility network topology. Learn more . Terminals impact traces A trace is an action that analyzes the paths in a utility network and returns features based on connectivity or traversability from the specified starting points. Learn more and connectivity associations.

                // Get the terminals for the feature.
                utilityElement.apply {
                    terminal = assetType.terminalConfiguration?.terminals?.first()
                }

If the feature A feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes. Learn more represents a line, you can optionally specify a location along the line to use as a trace location. This value is a percentage of the length of the line, beginning from the line’s ‘from’ point.

Use UtilityElement.fractionAlongEdge to define the location of the point along the line.

The following example uses the GeometryEngine to get the fraction of a tap location along the line.

            UtilityNetworkSourceType.Edge -> {
                val lineGeometry = arcGISFeature.geometry as Polyline

                utilityElement.fractionAlongEdge = GeometryEngine.fractionAlong(
                    line = GeometryEngine.createWithZ(geometry = lineGeometry, z = null),
                    point = tappedPoint,
                    tolerance = -1.0
                )