Perform valve isolation trace: Add filter barriers (#929)

Author: ZackAllen

src/Forms/Shared/Samples/Utility network/PerformValveIsolationTrace/PerformValveIsolationTrace.jpg

@@ -1,58 +1,79 @@
-<ContentPage
-    x:Class="ArcGISRuntimeXamarin.Samples.PerformValveIsolationTrace.PerformValveIsolationTrace"
-    xmlns="http://xamarin.com/schemas/2014/forms"
-    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
-    xmlns:esriUI="clr-namespace:Esri.ArcGISRuntime.Xamarin.Forms;assembly=Esri.ArcGISRuntime.Xamarin.Forms"
-    xmlns:resources="clr-namespace:Forms.Resources;assembly=ArcGISRuntime">
+<ContentPage x:Class="ArcGISRuntimeXamarin.Samples.PerformValveIsolationTrace.PerformValveIsolationTrace"
+             xmlns="http://xamarin.com/schemas/2014/forms"
+             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
+             xmlns:esriUI="clr-namespace:Esri.ArcGISRuntime.Xamarin.Forms;assembly=Esri.ArcGISRuntime.Xamarin.Forms"
+             xmlns:resources="clr-namespace:Forms.Resources;assembly=ArcGISRuntime">
     <RelativeLayout>
-        <esriUI:MapView
-            x:Name="MyMapView"
-            BindingContext="{x:Reference Name=ResponsiveFormContainer}"
-            Style="{StaticResource MapWithFormStyle}" />
+        <esriUI:MapView x:Name="MyMapView"
+                        BindingContext="{x:Reference Name=ResponsiveFormContainer}"
+                        GeoViewTapped="OnGeoViewTapped"
+                        Style="{StaticResource MapWithFormStyle}" />
         <resources:ResponsiveFormContainer x:Name="ResponsiveFormContainer">
             <StackLayout x:Name="FilterOptions" Orientation="Vertical">
-                <Label
-                    Margin="5"
-                    FontAttributes="Bold"
-                    Text="Choose Category for Filter Barrier:" />
+                <Label Margin="5"
+                       FontAttributes="Bold"
+                       Text="Choose Category for Filter Barrier:" />
                 <Grid>
                     <Grid.ColumnDefinitions>
                         <ColumnDefinition Width="*" />
                         <ColumnDefinition Width="auto" />
+                        <ColumnDefinition Width="auto" />
                     </Grid.ColumnDefinitions>
-                    <Picker
-                        x:Name="CategoryPicker"
-                        Grid.Column="0"
-                        Margin="5"
-                        ItemDisplayBinding="{Binding Name}"
-                        TextColor="Black"
-                        VerticalOptions="CenterAndExpand" />
-                    <Button
-                        Grid.Column="1"
-                        Margin="5"
-                        Clicked="OnTrace"
-                        Text="Trace" />
+                    <Picker x:Name="CategoryPicker"
+                            Grid.Column="0"
+                            Margin="5"
+                            ItemDisplayBinding="{Binding Name}"
+                            TextColor="Black"
+                            VerticalOptions="CenterAndExpand" />
+                    <Button Grid.Column="1"
+                            Margin="5"
+                            Clicked="OnTrace"
+                            Text="Trace" />
+                    <Button Grid.Column="2"
+                            Margin="5"
+                            Clicked="OnReset"
+                            Text="Reset" />
                 </Grid>
                 <StackLayout Orientation="Horizontal">
-                    <Switch
-                        x:Name="IncludeIsolatedFeatures"
-                        Margin="5"
-                        IsToggled="False" />
                     <Label Text="Include Isolated Features" VerticalOptions="Center" />
+                    <Switch x:Name="IncludeIsolatedFeatures"
+                            Margin="5"
+                            IsToggled="False" />
                 </StackLayout>
             </StackLayout>
         </resources:ResponsiveFormContainer>
-        <ActivityIndicator
-            x:Name="LoadingIndicator"
-            HorizontalOptions="CenterAndExpand"
-            IsRunning="True"
-            IsVisible="True"
-            RelativeLayout.HeightConstraint="{ConstraintExpression Type=RelativeToParent,
-                                                                   Property=Height,
-                                                                   Factor=1}"
-            RelativeLayout.WidthConstraint="{ConstraintExpression Type=RelativeToParent,
-                                                                  Property=Width,
-                                                                  Factor=1}"
-            VerticalOptions="CenterAndExpand" />
+        <ActivityIndicator x:Name="LoadingIndicator"
+                           HorizontalOptions="CenterAndExpand"
+                           IsRunning="True"
+                           IsVisible="True"
+                           RelativeLayout.HeightConstraint="{ConstraintExpression Type=RelativeToParent,
+                                                                                  Property=Height,
+                                                                                  Factor=1}"
+                           RelativeLayout.WidthConstraint="{ConstraintExpression Type=RelativeToParent,
+                                                                                 Property=Width,
+                                                                                 Factor=1}"
+                           VerticalOptions="CenterAndExpand" />
+        <Grid x:Name="PickerUI"
+              HorizontalOptions="CenterAndExpand"
+              IsVisible="False"
+              RelativeLayout.HeightConstraint="{ConstraintExpression Type=RelativeToParent,
+                                                                     Property=Height,
+                                                                     Factor=1}"
+              RelativeLayout.WidthConstraint="{ConstraintExpression Type=RelativeToParent,
+                                                                    Property=Width,
+                                                                    Factor=1}"
+              VerticalOptions="CenterAndExpand">
+            <Grid.RowDefinitions>
+                <RowDefinition Height="auto" />
+                <RowDefinition Height="*" />
+            </Grid.RowDefinitions>
+            <Label Grid.Row="0"
+                   Margin="5"
+                   HorizontalTextAlignment="Center"
+                   Text="Choose a terminal for this junction." />
+            <ListView x:Name="TerminalPicker"
+                      Grid.Row="1"
+                      ItemSelected="Terminal_Selected" />
+        </Grid>
     </RelativeLayout>
-</ContentPage>
+</ContentPage>

src/Forms/Shared/Samples/Utility network/PerformValveIsolationTrace/PerformValveIsolationTrace.xaml

@@ -1,4 +1,4 @@
-// Copyright 2020 Esri.
+// 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
@@ -13,10 +13,12 @@
 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 Xamarin.Forms;
 
 namespace ArcGISRuntimeXamarin.Samples.PerformValveIsolationTrace
@@ -25,8 +27,8 @@ namespace ArcGISRuntimeXamarin.Samples.PerformValveIsolationTrace
         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: "Create and set the configuration's filter barriers by selecting a category. Check or uncheck 'Include Isolated Features'. Tap 'Trace' to run a subnetwork-based isolation trace.",
-        tags: new[] { "category comparison", "condition barriers", "isolated features", "network analysis", "subnetwork trace", "trace configuration", "trace filter", "utility network" })]
+        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'. Tap 'Trace' to run a subnetwork-based isolation trace. Tap '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 : ContentPage
     {
         // Feature service for an electric utility network in Naperville, Illinois.
@@ -47,6 +49,12 @@ public partial class PerformValveIsolationTrace : ContentPage
         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<string> _terminalCompletionSource = null;
+
         public PerformValveIsolationTrace()
         {
             InitializeComponent();
@@ -112,6 +120,13 @@ private async void Initialize()
                 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));
 
@@ -148,7 +163,7 @@ private async void OnTrace(object sender, EventArgs e)
                     UtilityCategoryComparison categoryComparison = new UtilityCategoryComparison(category, UtilityCategoryComparisonOperator.Exists);
 
                     // Add the filter barrier.
-                    _configuration.Filter.Barriers = categoryComparison;
+                    _configuration.Filter = new UtilityTraceFilter() { Barriers = categoryComparison };
                 }
 
                 // Set the include isolated features property.
@@ -182,5 +197,103 @@ private async void OnTrace(object sender, EventArgs e)
                 LoadingIndicator.IsVisible = false;
             }
         }
+
+        private void OnReset(object sender, EventArgs 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
+            {
+                // Switch the UI for the user choosing the junction.
+                PickerUI.IsVisible = true;
+                MyMapView.GeoViewTapped -= OnGeoViewTapped;
+
+                // Load the terminals into the UI.
+                TerminalPicker.ItemsSource = terminals.Select(x => x.Name).ToList();
+                TerminalPicker.SelectedItem = null;
+
+                // Wait for the user to select a terminal.
+                _terminalCompletionSource = new TaskCompletionSource<string>();
+                string selectedName = await _terminalCompletionSource.Task;
+                return terminals.Where(x => x.Name.Equals(selectedName)).FirstOrDefault();
+            }
+            finally
+            {
+                // Make the main UI visible again.
+                PickerUI.IsVisible = false;
+                MyMapView.GeoViewTapped += OnGeoViewTapped;
+            }
+        }
+
+        private void Terminal_Selected(object sender, EventArgs e)
+        {
+            _terminalCompletionSource.TrySetResult(TerminalPicker.SelectedItem as string);
+        }
+
+        private async void OnGeoViewTapped(object sender, Esri.ArcGISRuntime.Xamarin.Forms.GeoViewInputEventArgs e)
+        {
+            try
+            {
+                LoadingIndicator.IsVisible = true;
+
+                // 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 = GeometryEngine.RemoveZ(line) as Polyline;
+                        double fraction = GeometryEngine.FractionAlong(line, 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)
+            {
+                await Application.Current.MainPage.DisplayAlert(ex.GetType().Name, ex.Message, "OK");
+            }
+            finally
+            {
+                LoadingIndicator.IsVisible = false;
+            }
+        }
     }
 }