New Sample: Add custom dynamic entity data source #1269

duffh · 2023-07-19T20:36:52Z

Description

Added new sample to demonstrate how to display data from a custom dynamic entity data source using a dynamic entity layer.

Type of change

New sample implementation

Platforms tested on

Checklist

Self-review of changes
All changes work as expected on all affected platforms
There are no warnings related to changes
Code is commented and follows .NET conventions and standards
Codemaid and XAML styler extensions have been run on every changed file
No unrelated changes have been made to any other code or project files
Screenshots are correct size and display in description tab (800 x 600 on Windows, MAUI mobile platforms use the MAUI Windows screenshot)

gdestigter

This looks like a really good start @duffh. Mostly code / sample simplification comments from me.

I think we should try to find a way to parse JSON using standard System.Text.Json.JsonElement. That would allow us to get rid of the deserializer specific classes and simplify the sample. I can probably help with that if you need.

I also think we should opt for a static schema instead of trying to infer it from the file. I was testing with a bunch of different files, so that came in handy, but in a sample, we don't really need that. Up to you though.

I like the labelling and callout on the dynamic entity. It gives a sign that the entities from a custom source are first-class citizens in the API 👍

gdestigter · 2023-07-19T21:15:40Z

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/CustomFileSource.cs

+        private Task? _processTask;
+        private StreamReader? _streamReader;
+        private CancellationTokenSource? _cancellationTokenSource;
+        private TaskCompletionSource<object?>? _pauseTask;


If we're not actively controlling playback of the file, I think we can remove _pauseTask altogether to simplify the code.

gdestigter · 2023-07-19T21:16:19Z

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/CustomFileSource.cs

+        protected override async Task<DynamicEntityDataSourceInfo> OnLoadAsync()
+        {
+            // Derive schema from the first row in the custom data source.
+            var fields = await InferSchemaAsync();


To simplify, we can just return a static list of fields instead of inferring the schema.

gdestigter · 2023-07-19T21:20:09Z

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/CustomFileSource.cs

+                    var processed = await ProcessNextObservation();
+
+                    // If the observation was not processed, continue to the next observation.
+                    if (!processed) continue;


I noticed an End-of-Stream bug here (my bug - sorry). We should check _streamReader.EndOfStream and break out of the loop, or we'll run forever.

gdestigter · 2023-07-19T21:31:16Z

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/CustomFileSource.cs

+            return fields;
+        }
+
+        public async Task StepAsync()


I don't think we need this method if we're not managing file playback.

gdestigter · 2023-07-19T21:34:17Z

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/CustomFileSource.cs

+            {
+                // Parse the observation from the file using the JsonGeoElementParser.
+                // This will return a graphic holding a  MapPoint and a dictionary of attributes.
+                var graphic = JsonGeoElementParser.ParseGraphicFromJson(json);


Maybe we can find a different way to do the parsing so we're not deserializing into a Graphic. I don't think we want to do that in a sample as DynamicEntityObservation and Graphic are not related (except that they both derive from GeoElement) and we wouldn't want to confuse someone.

Parsing to a standard JsonElement might be the ticket here. If we do that, we can probably get rid of the whole JsonGeoElement which is kind of confusing in a sample.

Good call, that simplifies things a lot.

gdestigter · 2023-07-19T21:36:11Z

...les/Samples/Layers/AddCustomDynamicEntityDataSource/AddCustomDynamicEntityDataSource.xaml.cs

+            // Create a new custom file source.
+            // This takes the path to the desired data source and the field name that will be used as the entity id and the delay between each observation that is processed.
+            // In this example we are using a json file as our custom data source.
+            // This field name should be a unique identifier for each entity.


In our design discussions, there was some confusion about the field name and the field value. Probably best to be explicit about the field value being the unique identifier.

gdestigter · 2023-07-19T21:38:44Z

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/CustomFileSource.cs

+            }
+        }
+
+        private async Task<List<Field>> InferSchemaAsync()


I think I'd opt for removing this altogether and just using a static list of fields that's tied to the data.

gdestigter · 2023-07-19T21:45:28Z

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/CustomFileSource.cs

+
+namespace ArcGIS.Samples.AddCustomDynamicEntityDataSource
+{
+    public class CustomFileSource : DynamicEntityDataSource


I wonder if we should rename this to something more specific to the data (i.e. SimulatedAisDataSource or something similar). Then the sample could be less generic and more tightly coupled with the data. The ability to create data specific custom data sources is a reasonable message to give to users as well.

gdestigter · 2023-07-19T21:52:43Z

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/CustomFileSource.cs

+                    graphic.Geometry = GeometryEngine.Project(graphic.Geometry, SpatialReference);
+                }
+
+                // Add the observation to the dynamic entity layer for presentation on the map.


We need to be careful the separation of the data source and the layer. Here we're adding an observation to the data source which can happen whether or not the data source is contained by a layer or not.

gdestigter

Looks good from my end 👍. Just minor comments.

gdestigter · 2023-07-20T16:51:35Z

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/SimulatedDataSource.cs

+                    if (!processed) continue;
+
+                    // If the end of the file has been reached, break out of the loop.
+                    if (_streamReader.EndOfStream) _break;


I think this needs to be moved above the !processed check.

...les/Samples/Layers/AddCustomDynamicEntityDataSource/AddCustomDynamicEntityDataSource.xaml.cs

gdestigter · 2023-07-20T16:56:45Z

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/SimulatedDataSource.cs

+        public string FilePath { get; }
+        public string EntityIdField { get; }
+        public TimeSpan Delay { get; }
+        public SpatialReference SpatialReference { get; set; } = SpatialReferences.Wgs84;


To simplify, we can probably remove this property since we're assuming WGS84 for this data source.

…aSource/AddCustomDynamicEntityDataSource.xaml.cs Co-authored-by: Greg De Stigter <[email protected]>

…hub.com/Esri/arcgis-maps-sdk-dotnet-samples into hduff/custom-dynamic-entity-data-source

williambohrmann3 · 2023-07-21T18:52:39Z

...Viewer/Samples/Layers/AddCustomDynamicEntityDataSource/AddCustomDynamicEntityDataSource.xaml

+    xmlns:esri="using:Esri.ArcGISRuntime"
+    xmlns:esriUI="using:Esri.ArcGISRuntime.UI.Controls">
+    <Grid>
+        <esriUI:MapView x:Name="MyMapView" />


WPF & WinUI: missing GeoViewTapped event subscriptions

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/readme.md

Generate sample files and implement MAUI sample

c5714ed

gdestigter reviewed Jul 19, 2023

View reviewed changes

implement feedback

662318b

gdestigter approved these changes Jul 20, 2023

View reviewed changes

duffh and others added 9 commits July 21, 2023 13:28

Update src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDat…

7efc328

…aSource/AddCustomDynamicEntityDataSource.xaml.cs Co-authored-by: Greg De Stigter <[email protected]>

Implement WinUI and WPF samples

62201f0

Merge branch 'hduff/custom-dynamic-entity-data-source' of https://git…

89894a5

…hub.com/Esri/arcgis-maps-sdk-dotnet-samples into hduff/custom-dynamic-entity-data-source

tidy up class files

451f080

finalized WinUI implementation

e9c8098

Updated readme

893ad34

readme sync

15cbf8f

Implement WPF .NET Framework

c379a79

Merge branch 'v.next' into hduff/custom-dynamic-entity-data-source

bee1665

duffh marked this pull request as ready for review July 21, 2023 17:31

duffh changed the title ~~New Sample: Add custom dynamic entity source~~ New Sample: Add custom dynamic entity data source Jul 21, 2023

duffh added 2 commits July 21, 2023 18:52

update readme

5116aa0

fix spacing

9628585

williambohrmann3 reviewed Jul 21, 2023

View reviewed changes

duffh and others added 2 commits July 21, 2023 20:43

implement feedback

30ef78f

subscribe to GeoViewTapped, XAML styler

7a4f1f5

williambohrmann3 reviewed Jul 21, 2023

View reviewed changes

src/MAUI/Maui.Samples/Samples/Layers/AddCustomDynamicEntityDataSource/readme.md Outdated Show resolved Hide resolved

duffh and others added 6 commits July 24, 2023 10:44

updated feedback

dc81404

sample sync

f491561

pruned JSON

613cabe

change basemap style

97160ba

callout attributes

3d379ea

screenshots

85c5c2b

williambohrmann3 merged commit 41b12d9 into v.next Jul 27, 2023
2 checks passed

williambohrmann3 deleted the hduff/custom-dynamic-entity-data-source branch July 27, 2023 23:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Sample: Add custom dynamic entity data source #1269

New Sample: Add custom dynamic entity data source #1269

duffh commented Jul 19, 2023 •

edited

Loading

gdestigter left a comment

gdestigter Jul 19, 2023

gdestigter Jul 19, 2023

gdestigter Jul 19, 2023

gdestigter Jul 19, 2023

gdestigter Jul 19, 2023

gdestigter Jul 19, 2023

duffh Jul 20, 2023

gdestigter Jul 19, 2023

gdestigter Jul 19, 2023

gdestigter Jul 19, 2023

gdestigter Jul 19, 2023

gdestigter left a comment

gdestigter Jul 20, 2023

gdestigter Jul 20, 2023

williambohrmann3 Jul 21, 2023

New Sample: Add custom dynamic entity data source #1269

New Sample: Add custom dynamic entity data source #1269

Conversation

duffh commented Jul 19, 2023 • edited Loading

Description

Type of change

Platforms tested on

Checklist

gdestigter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gdestigter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

duffh commented Jul 19, 2023 •

edited

Loading