Perform valve isolation 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 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 // Copyright 2021 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.  using Esri.ArcGISRuntime.Data; using Esri.ArcGISRuntime.Geometry; using Esri.ArcGISRuntime.Mapping; using Esri.ArcGISRuntime.Security; using Esri.ArcGISRuntime.Symbology; using Esri.ArcGISRuntime.UI; using Esri.ArcGISRuntime.UI.Controls; using Esri.ArcGISRuntime.UtilityNetworks; using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using System.Windows;  namespace ArcGIS.WPF.Samples.PerformValveIsolationTrace {  [ArcGIS.Samples.Shared.Attributes.Sample(  name: "Perform valve isolation trace",  category: "Utility network",  description: "Run a filtered trace to locate operable features that will isolate an area from the flow of network resources.",  instructions: "Tap on one or more features to use as filter barriers or create and set the configuration's filter barriers by selecting a category. Check or uncheck 'Include Isolated Features'. Click 'Trace' to run a subnetwork-based isolation trace. Click 'Reset' to clear filter barriers.",  tags: new[] { "category comparison", "condition barriers", "filter barriers", "isolated features", "network analysis", "subnetwork trace", "trace configuration", "trace filter", "utility network" })]  public partial class PerformValveIsolationTrace  {  // Feature service for an electric utility network in Naperville, Illinois.  private UtilityNetwork _utilityNetwork;   // For creating the default trace configuration.  private const string DomainNetworkName = "Pipeline";  private const string TierName = "Pipe Distribution System";  private UtilityTraceConfiguration _configuration;   // For creating the default starting location.  private const string NetworkSourceName = "Gas Device";  private const string AssetGroupName = "Meter";  private const string AssetTypeName = "Customer";  private const string GlobalId = "{98A06E95-70BE-43E7-91B7-E34C9D3CB9FF}";  private UtilityElement _startingLocation;   private UtilityTraceParameters _parameters;  private GraphicsOverlay _barrierOverlay;   // Task completion source for the user selected terminal.  private TaskCompletionSource<UtilityTerminal> _terminalCompletionSource = null;   public PerformValveIsolationTrace()  {  InitializeComponent();  _ = Initialize();  }   private async Task Initialize()  {  // As of ArcGIS Enterprise 10.8.1, using utility network functionality requires a licensed user. The following login for the sample server is licensed to perform utility network operations.  AuthenticationManager.Current.ChallengeHandler = new ChallengeHandler(async (info) =>  {  try  {  // WARNING: Never hardcode login information in a production application. This is done solely for the sake of the sample.  string sampleServer7User = "viewer01";  string sampleServer7Pass = "I68VGU^nMurF";   return await AccessTokenCredential.CreateAsync(info.ServiceUri, sampleServer7User, sampleServer7Pass);  }  catch (Exception ex)  {  System.Diagnostics.Debug.WriteLine(ex.Message);  return null;  }  });   try  {  // Disable the UI.  FilterOptions.IsEnabled = false;   // Create a map with layers in this utility network.  MyMapView.Map = new Map(new Uri("https://sampleserver7.arcgisonline.com/portal/home/item.html?id=f439b4724bb54ac088a2c21eaf70da7b"));  await MyMapView.Map.LoadAsync();   // Get the utility network from the map.  _utilityNetwork = MyMapView.Map.UtilityNetworks.FirstOrDefault();  await _utilityNetwork.LoadAsync();   // Get a trace configuration from a tier.  UtilityDomainNetwork domainNetwork = _utilityNetwork.Definition.GetDomainNetwork(DomainNetworkName) ?? throw new ArgumentException(DomainNetworkName);  UtilityTier tier = domainNetwork.GetTier(TierName) ?? throw new ArgumentException(TierName);  _configuration = tier.GetDefaultTraceConfiguration();   // Create a trace filter.  _configuration.Filter = new UtilityTraceFilter();   // Get a default starting location.  UtilityNetworkSource networkSource = _utilityNetwork.Definition.GetNetworkSource(NetworkSourceName) ?? throw new ArgumentException(NetworkSourceName);  UtilityAssetGroup assetGroup = networkSource.GetAssetGroup(AssetGroupName) ?? throw new ArgumentException(AssetGroupName);  UtilityAssetType assetType = assetGroup.GetAssetType(AssetTypeName) ?? throw new ArgumentException(AssetTypeName);  Guid globalId = Guid.Parse(GlobalId);  _startingLocation = _utilityNetwork.CreateElement(assetType, globalId);   // Create a graphics overlay.  GraphicsOverlay overlay = new GraphicsOverlay();  MyMapView.GraphicsOverlays.Add(overlay);   // Display starting location.  IEnumerable<ArcGISFeature> elementFeatures = await _utilityNetwork.GetFeaturesForElementsAsync(new List<UtilityElement> { _startingLocation });  MapPoint startingLocationGeometry = elementFeatures.FirstOrDefault().Geometry as MapPoint;  Symbol symbol = new SimpleMarkerSymbol(SimpleMarkerSymbolStyle.Cross, System.Drawing.Color.LimeGreen, 25d);  Graphic graphic = new Graphic(startingLocationGeometry, symbol);  overlay.Graphics.Add(graphic);   // Create a graphics overlay for barriers.  _barrierOverlay = new GraphicsOverlay();  MyMapView.GraphicsOverlays.Add(_barrierOverlay);   // Create the utility trace parameters.  _parameters = new UtilityTraceParameters(UtilityTraceType.Isolation, new[] { _startingLocation });   // Set the starting viewpoint.  await MyMapView.SetViewpointAsync(new Viewpoint(startingLocationGeometry, 3000));   // Build the choice list for categories populated with the `Name` property of each `UtilityCategory` in the `UtilityNetworkDefinition`.  Categories.ItemsSource = _utilityNetwork.Definition.Categories;  Categories.SelectedItem = _utilityNetwork.Definition.Categories.First();   // Enable the UI.  FilterOptions.IsEnabled = true;  }  catch (Exception ex)  {  MessageBox.Show(ex.Message, ex.GetType().Name, MessageBoxButton.OK, MessageBoxImage.Error);  }  finally  {  LoadingBar.Visibility = Visibility.Collapsed;  }  }   private async void OnTrace(object sender, RoutedEventArgs e)  {  try  {  LoadingBar.Visibility = Visibility.Visible;   // Clear previous selection from the layers.  MyMapView.Map.OperationalLayers.OfType<FeatureLayer>().ToList().ForEach(layer => layer.ClearSelection());   if (Categories.SelectedItem is UtilityCategory category)  {  // NOTE: UtilityNetworkAttributeComparison or UtilityCategoryComparison with Operator.DoesNotExists  // can also be used. These conditions can be joined with either UtilityTraceOrCondition or UtilityTraceAndCondition.  UtilityCategoryComparison categoryComparison = new UtilityCategoryComparison(category, UtilityCategoryComparisonOperator.Exists);   // Add the filter barrier.  _configuration.Filter = new UtilityTraceFilter() { Barriers = categoryComparison };  }   // Set the include isolated features property.  _configuration.IncludeIsolatedFeatures = IncludeIsolatedFeatures.IsChecked == true;   // Build parameters for isolation trace.  _parameters.TraceConfiguration = _configuration;   // Get the trace result from trace.  IEnumerable<UtilityTraceResult> traceResult = await _utilityNetwork.TraceAsync(_parameters);  UtilityElementTraceResult elementTraceResult = traceResult?.FirstOrDefault() as UtilityElementTraceResult;   // Select all the features from the result.  if (elementTraceResult?.Elements?.Count > 0)  {  foreach (FeatureLayer layer in MyMapView.Map.OperationalLayers.OfType<FeatureLayer>())  {  IEnumerable<UtilityElement> elements = elementTraceResult.Elements.Where(element => element.NetworkSource.Name == layer.FeatureTable.TableName);  IEnumerable<Feature> features = await _utilityNetwork.GetFeaturesForElementsAsync(elements);  layer.SelectFeatures(features);  }  }  }  catch (Exception ex)  {  MessageBox.Show(ex.Message, ex.GetType().Name, MessageBoxButton.OK, MessageBoxImage.Error);  }  finally  {  LoadingBar.Visibility = Visibility.Collapsed;  }  }   private void OnReset(object sender, RoutedEventArgs e)  {  _parameters.Barriers.Clear();  _barrierOverlay.Graphics.Clear();  foreach (FeatureLayer layer in MyMapView.Map.OperationalLayers.OfType<FeatureLayer>())  {  layer.ClearSelection();  }  }   private async Task<UtilityTerminal> GetTerminalAsync(IEnumerable<UtilityTerminal> terminals)  {  try  {  MyMapView.GeoViewTapped -= OnGeoViewTapped;  TerminalPicker.Visibility = Visibility.Visible;  MainUI.Visibility = Visibility.Collapsed;  Picker.ItemsSource = terminals;  Picker.SelectedIndex = 1;   // Waits for user to select a terminal.  _terminalCompletionSource = new TaskCompletionSource<UtilityTerminal>();  return await _terminalCompletionSource.Task;  }  finally  {  TerminalPicker.Visibility = Visibility.Collapsed;  MainUI.Visibility = Visibility.Visible;  MyMapView.GeoViewTapped += OnGeoViewTapped;  }  }   private void OnTerminalSelected(object sender, RoutedEventArgs e)  {  _terminalCompletionSource.TrySetResult(Picker.SelectedItem as UtilityTerminal);  }   private async void OnGeoViewTapped(object sender, GeoViewInputEventArgs e)  {  try  {  LoadingBar.Visibility = Visibility.Visible;   // Identify the feature to be used.  IEnumerable<IdentifyLayerResult> identifyResult = await MyMapView.IdentifyLayersAsync(e.Position, 10.0, false);  ArcGISFeature feature = identifyResult?.FirstOrDefault()?.GeoElements?.FirstOrDefault() as ArcGISFeature;  if (feature == null) { return; }   // Create element from the identified feature.  UtilityElement element = _utilityNetwork.CreateElement(feature);   if (element.NetworkSource.SourceType == UtilityNetworkSourceType.Junction)  {  // Select terminal for junction feature.  IEnumerable<UtilityTerminal> terminals = element.AssetType.TerminalConfiguration?.Terminals;  if (terminals?.Count() > 1)  {  element.Terminal = await GetTerminalAsync(terminals);  }  }  else if (element.NetworkSource.SourceType == UtilityNetworkSourceType.Edge)  {  // Compute how far tapped location is along the edge feature.  if (feature.Geometry is Polyline line)  {  // Remove elevation data, FractionAlong only supports 2D lines.  line = line.RemoveZ() as Polyline;  double fraction = line.FractionAlong(e.Location, -1);   // Check for rare edge case where the fraction is invalid.  if (double.IsNaN(fraction)) { return; }   // Set the fraction of the utility element.  element.FractionAlongEdge = fraction;  }  }   // Check whether starting location or barrier is added to update the right collection and symbology.  _parameters.Barriers.Add(element);  Symbol symbol = new SimpleMarkerSymbol(SimpleMarkerSymbolStyle.X, System.Drawing.Color.OrangeRed, 25d);   // Add a graphic for the new utility element.  Graphic traceLocationGraphic = new Graphic(feature.Geometry as MapPoint ?? e.Location, symbol);  _barrierOverlay.Graphics.Add(traceLocationGraphic);  }  catch (Exception ex)  {  MessageBox.Show(ex.Message, ex.GetType().Name, MessageBoxButton.OK, MessageBoxImage.Error);  }  finally  {  LoadingBar.Visibility = Visibility.Hidden;  }  }  } }