Create graphics for utility associations in a utility network.
Use case
Visualizing utility associations can help you to better understand trace results and the topology of your utility network. For example, connectivity associations allow you to model connectivity between two junctions that don't have geometric coincidence (are not in the same location); structural attachment associations allow you to model equipment that may be attached to structures; and containment associations allow you to model features contained within other features.
How to use the sample
Pan and zoom around the map. Observe graphics that show utility associations between junctions.
How it works
Create an UtilityNetwork with a feature service URL, add it to the map's utilityNetworks list and load it.
Add a FeatureLayer to the map for every UtilityNetworkSource of type EDGE or JUNCTION.
Create a GraphicsOverlay for the utility associations.
Add a NavigationChangedListener to listen for NavigationChangedEvents.
When the sample starts and every time the viewpoint changes:
Get the geometry of the map view's extent.
Get the associations that are within the current extent using getAssociationsAsync(extent).
Get the UtilityAssociationType for each association.
Create a Graphic using the Geometry property of the association and a preferred symbol.
Add the graphic to the graphics overlay.
Relevant API
GraphicsOverlay
ServiceGeodatabase
UtilityAssociation
UtilityAssociationType
UtilityNetwork
About the data
The Naperville electrical feature service in this sample represents an electric network in Naperville, Illinois, which contains a utility network used to run the subnetwork-based trace.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*
* Copyright 2020 Esri
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/package com.esri.arcgisruntime.sample.displayutilityassociations
import android.graphics.Color
import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import androidx.appcompat.widget.AppCompatImageView
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment
import com.esri.arcgisruntime.layers.FeatureLayer
import com.esri.arcgisruntime.mapping.ArcGISMap
import com.esri.arcgisruntime.mapping.BasemapStyle
import com.esri.arcgisruntime.mapping.Viewpoint
import com.esri.arcgisruntime.mapping.view.Graphic
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay
import com.esri.arcgisruntime.mapping.view.MapView
import com.esri.arcgisruntime.security.UserCredential
import com.esri.arcgisruntime.symbology.SimpleLineSymbol
import com.esri.arcgisruntime.utilitynetworks.UtilityAssociationType
import com.esri.arcgisruntime.utilitynetworks.UtilityNetwork
import com.esri.arcgisruntime.utilitynetworks.UtilityNetworkSource
import com.esri.arcgisruntime.sample.displayutilityassociations.databinding.ActivityMainBinding
import java.util.UUID
classMainActivity : AppCompatActivity() {
// max scale at which to create graphics for the associationsprivateval maxScale = 2000// create the utility networkprivateval utilityNetwork =
UtilityNetwork("https://sampleserver7.arcgisonline.com/server/rest/services/UtilityNetwork/NapervilleElectric/FeatureServer").apply {
// set user credentials to authenticate with the service// NOTE: a licensed user is required to perform utility network operations credential = UserCredential("viewer01", "I68VGU^nMurF")
}
// overlay to hold graphics for all of the associationsprivateval associationsOverlay by lazy { GraphicsOverlay() }
// create a green dotted line symbol for attachmentprivateval attachmentSymbol by lazy {
SimpleLineSymbol(
SimpleLineSymbol.Style.DOT,
Color.GREEN,
5.0f )
}
// create a red dotted line symbol for connectivityprivateval connectivitySymbol by lazy {
SimpleLineSymbol(
SimpleLineSymbol.Style.DOT,
Color.RED,
5.0f )
}
privateval activityMainBinding by lazy {
ActivityMainBinding.inflate(layoutInflater)
}
privateval mapView: MapView by lazy {
activityMainBinding.mapView
}
privateval attachmentSwatch: AppCompatImageView by lazy {
activityMainBinding.subLayout.attachmentSwatch
}
privateval connectivitySwatch: AppCompatImageView by lazy {
activityMainBinding.subLayout.connectivitySwatch
}
overridefunonCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(activityMainBinding.root)
// authentication with an API key or named user is required to access basemaps and other// location services ArcGISRuntimeEnvironment.setApiKey(BuildConfig.API_KEY)
// create a new map and add the utility network to itval utilityNetworkMap = ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC).apply {
utilityNetworks.add(utilityNetwork)
}
mapView.apply {
// add a topographic basemap with a viewpoint at several utility network associations map = utilityNetworkMap
setViewpoint(Viewpoint(41.8057655, -88.1489692, 50.0))
// add the a graphics overlay to hold association graphics graphicsOverlays.add(associationsOverlay)
}
// load the utility network utilityNetwork.loadAsync()
utilityNetwork.addDoneLoadingListener {
// get all of the edges and junctions in the networkval edges =
utilityNetwork.definition.networkSources.filter { it.sourceType == UtilityNetworkSource.Type.EDGE }
val junctions =
utilityNetwork.definition.networkSources.filter { it.sourceType == UtilityNetworkSource.Type.JUNCTION }
// add all edges that are not subnet lines to the map edges.filter { it.sourceUsageType != UtilityNetworkSource.UsageType.SUBNET_LINE }
.forEach { source ->
mapView.map.operationalLayers.add(FeatureLayer(source.featureTable))
}
// add all junctions to the map junctions.forEach { source ->
mapView.map.operationalLayers.add(FeatureLayer(source?.featureTable))
}
// populate the legend in the UIval attachmentSwatchFuture = attachmentSymbol.createSwatchAsync(this, Color.TRANSPARENT)
attachmentSwatch.setImageBitmap(attachmentSwatchFuture.get())
val connectSwatchFuture = connectivitySymbol.createSwatchAsync(this, Color.TRANSPARENT)
connectivitySwatch.setImageBitmap(connectSwatchFuture.get())
// add association graphics at the initial view point addAssociationGraphicsAsync()
// listen for navigation changes mapView.addNavigationChangedListener {
// add association graphics for viewpoint after navigation change addAssociationGraphicsAsync()
}
}
}
/**
* Add association graphics for the map view's current extent.
*/privatefunaddAssociationGraphicsAsync() {
// if the current viewpoint is outside of max scale, return and don't add association graphicsif (mapView.getCurrentViewpoint(Viewpoint.Type.CENTER_AND_SCALE).targetScale >= maxScale) {
return }
// check if the current viewpoint has an extent (mapView.getCurrentViewpoint(Viewpoint.Type.BOUNDING_GEOMETRY).targetGeometry.extent)?.let { extent ->
// get all of the associations in extentval associationsFuture = utilityNetwork.getAssociationsAsync(extent)
associationsFuture.addDoneListener {
val associations = associationsFuture.get()
associations.forEach { association ->
// if the graphics overlay doesn't already contain the associationif (!associationsOverlay.graphics.any {
UUID.fromString(it.attributes["GlobalId"]?.toString()) == association.globalId
}) {
// add a graphic for the associationval symbol = when (association.associationType) {
UtilityAssociationType.ATTACHMENT -> attachmentSymbol
UtilityAssociationType.CONNECTIVITY -> connectivitySymbol
else -> null }
val graphic = Graphic(association.geometry, symbol).apply {
attributes["GlobalId"] = association.globalId
}
associationsOverlay.graphics.add(graphic)
}
}
}
}
}
overridefunonResume() {
super.onResume()
mapView.resume()
}
overridefunonPause() {
mapView.pause()
super.onPause()
}
overridefunonDestroy() {
mapView.dispose()
super.onDestroy()
}
}