Added node extensions to library

Author: Roog

src/EmberLibConsumer.net/Lawo.EmberPlusSharp/Model/Element.cs

@@ -64,8 +64,8 @@ public object Tag
             get { return this.tag; }
             set { this.SetValue(ref this.tag, value); }
         }
+
         /// <inheritdoc/>
-        
         public string GetPath()
         {
             var path = new StringBuilder(64);

src/EmberPlusConsumerClassLib/EmberHelpers/NodeExtensions.cs

@@ -0,0 +1,97 @@
+#region copyright
+/*
+ * NuGet EmBER+ Consumer Lib
+ *
+ * Copyright (c) 2021 Roger Sandholm & Fredrik Bergholtz, Stockholm, Sweden
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#endregion copyright
+
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using EmberPlusConsumerClassLib.Model;
+using Lawo.EmberPlusSharp.Model;
+
+namespace EmberPlusConsumerClassLib.EmberHelpers
+{
+    public static class NodeExtensions
+    {
+        public static async Task<IParameter> GetParameter(this INode node, string s, Consumer<MyRoot> consumer)
+        {
+            if (node.Children.Count == 0)
+            {
+                node.ChildrenRetrievalPolicy = ChildrenRetrievalPolicy.DirectOnly;
+                await consumer.SendAsync();
+            }
+            return node.Children.FirstOrDefault(c => c.Identifier == s) as IParameter;
+        }
+
+        public static async Task<IFunction> GetFunction(this INode node, string s, Consumer<MyRoot> consumer)
+        {
+            if (node.Children.Count == 0)
+            {
+                node.ChildrenRetrievalPolicy = ChildrenRetrievalPolicy.DirectOnly;
+                await consumer.SendAsync();
+            }
+            return node.Children.FirstOrDefault(c => c.Identifier == s) as IFunction;
+        }
+
+        public static async Task<IEnumerable<INode>> ChildNodes(this INode node, Consumer<MyRoot> consumer)
+        {
+            if (node.Children.Count == 0)
+            {
+                node.ChildrenRetrievalPolicy = ChildrenRetrievalPolicy.DirectOnly;
+                await consumer.SendAsync();
+            }
+            return node.Children.OfType<INode>();
+        }
+        
+        public static async Task<INode> GetChildNode(this INode node, string identifier, Consumer<MyRoot> consumer)
+        {
+            if (node.Children.Count == 0)
+            {
+                node.ChildrenRetrievalPolicy = ChildrenRetrievalPolicy.DirectOnly;
+                await consumer.SendAsync();
+            }
+            return node.Children.OfType<INode>().FirstOrDefault(c => c.Identifier == identifier);
+        }
+
+        public static async Task<INode> NavigateToNode(this INode root, string path, Consumer<MyRoot> consumer)
+        {
+            string[] steps = path.Split('/');
+
+            INode node = root;
+            foreach (string identifier in steps)
+            {
+                node = await node.GetChildNode(identifier, consumer);
+                if (node == null)
+                {
+                    break;
+                }
+            }
+            return node;
+        }
+    }
+}

src/EmberPlusConsumerClassLib/EmberPlusConsumerClassLib.csproj

@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netstandard2.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="NLog" Version="4.7.4" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\EmberLibConsumer.net\Lawo.EmberPlusSharp\Lawo.EmberPlusSharp.csproj" />
+  </ItemGroup>
+
+</Project>

src/EmberPlusConsumerClassLib/Model/MyRoot.cs

@@ -0,0 +1,39 @@
+#region copyright
+/*
+ * NuGet EmBER+ Consumer Lib
+ *
+ * Copyright (c) 2021 Roger Sandholm & Fredrik Bergholtz, Stockholm, Sweden
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#endregion copyright
+
+using Lawo.EmberPlusSharp.Model;
+
+namespace EmberPlusConsumerClassLib.Model
+{
+    public sealed class MyRoot : DynamicRoot<MyRoot>
+    {
+        // Root for consumer
+    }
+}

src/Nuget.EmberPlusConsumerLib.NetStandard/Nuget.EmberPlusConsumerLib.NetStandard.csproj

@@ -51,7 +51,12 @@
       <Private>true</Private>
       <IncludeAssets>true</IncludeAssets>
     </ProjectReference>
-    <ProjectReference Include="..\EmberLibConsumer.net\Lawo\Lawo.csproj">  
+    <ProjectReference Include="..\EmberLibConsumer.net\Lawo\Lawo.csproj">
+      <Pack>true</Pack>
+      <Private>true</Private>
+      <IncludeAssets>true</IncludeAssets>
+    </ProjectReference>
+      <ProjectReference Include="..\EmberPlusConsumerClassLib\EmberPlusConsumerClassLib.csproj">
       <Pack>true</Pack>
       <Private>true</Private>
       <IncludeAssets>true</IncludeAssets>

src/nuget-ember-plus-consumer-lib.sln

@@ -10,13 +10,13 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		EmberLibConsumer.net\CodeAnalysis.ruleset = EmberLibConsumer.net\CodeAnalysis.ruleset
 		EmberLibConsumer.net\CodeAnalysisDictionary.xml = EmberLibConsumer.net\CodeAnalysisDictionary.xml
 		EmberLibConsumer.net\CodeCoverage.runsettings = EmberLibConsumer.net\CodeCoverage.runsettings
+		..\.github\workflows\ContinuousIntegration.yml = ..\.github\workflows\ContinuousIntegration.yml
 		EmberLibConsumer.net\Logo.ico = EmberLibConsumer.net\Logo.ico
 		EmberLibConsumer.net\README.md = EmberLibConsumer.net\README.md
+		..\README.md = ..\README.md
 		EmberLibConsumer.net\SharedAssemblyInfo.cs = EmberLibConsumer.net\SharedAssemblyInfo.cs
 		EmberLibConsumer.net\StrongNameKey.snk = EmberLibConsumer.net\StrongNameKey.snk
 		EmberLibConsumer.net\stylecop.json = EmberLibConsumer.net\stylecop.json
-		..\README.md = ..\README.md
-		..\.github\workflows\ContinuousIntegration.yml = ..\.github\workflows\ContinuousIntegration.yml
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Lawo.UnitTesting", "EmberLibConsumer.net\Lawo.UnitTesting\Lawo.UnitTesting.csproj", "{018D45FD-BC81-433E-9B90-788D4AE2D31C}"
@@ -33,12 +33,14 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Lawo.EmberPlusSharp", "Embe
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Lawo", "EmberLibConsumer.net\Lawo\Lawo.csproj", "{47067303-08C7-442D-AEFD-5793595B179F}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Nuget.EmberPlusConsumerLib.NetStandard", "Nuget.EmberPlusConsumerLib.NetStandard\Nuget.EmberPlusConsumerLib.NetStandard.csproj", "{FF061512-7A72-482B-BE37-2F4C73B0D7FE}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Nuget.EmberPlusConsumerLib.NetStandard", "Nuget.EmberPlusConsumerLib.NetStandard\Nuget.EmberPlusConsumerLib.NetStandard.csproj", "{FF061512-7A72-482B-BE37-2F4C73B0D7FE}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{CC781669-0B88-4B87-8440-132EB37FF16D}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ember-plus", "ember-plus", "{3827E5DC-6235-49F5-80B3-CAFA0AE2D893}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "EmberPlusConsumerClassLib", "EmberPlusConsumerClassLib\EmberPlusConsumerClassLib.csproj", "{402C4B73-F8BD-4806-9A03-5AD21CCFF365}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -235,23 +237,48 @@ Global
 		{FF061512-7A72-482B-BE37-2F4C73B0D7FE}.Release|x64.Build.0 = Release|Any CPU
 		{FF061512-7A72-482B-BE37-2F4C73B0D7FE}.Release|x86.ActiveCfg = Release|Any CPU
 		{FF061512-7A72-482B-BE37-2F4C73B0D7FE}.Release|x86.Build.0 = Release|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Debug|ARM.ActiveCfg = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Debug|ARM.Build.0 = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Debug|x64.Build.0 = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Debug|x86.Build.0 = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.PackNuGet|Any CPU.ActiveCfg = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.PackNuGet|Any CPU.Build.0 = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.PackNuGet|ARM.ActiveCfg = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.PackNuGet|ARM.Build.0 = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.PackNuGet|x64.ActiveCfg = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.PackNuGet|x64.Build.0 = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.PackNuGet|x86.ActiveCfg = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.PackNuGet|x86.Build.0 = Debug|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Release|Any CPU.Build.0 = Release|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Release|ARM.ActiveCfg = Release|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Release|ARM.Build.0 = Release|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Release|x64.ActiveCfg = Release|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Release|x64.Build.0 = Release|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Release|x86.ActiveCfg = Release|Any CPU
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
-	GlobalSection(ExtensibilityGlobals) = postSolution
-		SolutionGuid = {4CCEB7E0-F2FD-41D3-9E4E-BAA95A7FC762}
-	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
-		{47067303-08C7-442D-AEFD-5793595B179F} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
-		{1BE88B2D-2A49-47C0-9C60-59D662C0821A} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
 		{D93DC0DD-C137-428F-B84B-3F4387124C85} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
-		{A81DC2B8-8E3C-442E-B311-A38B22D18DFF} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
-		{8273A6F1-CFC5-4A5E-8B2B-089EA6317312} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
-		{C9E3FDA8-F9A9-48BC-9249-36E86A18D371} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
 		{018D45FD-BC81-433E-9B90-788D4AE2D31C} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
 		{60335AC8-4085-4890-AF0C-51D2273772E5} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
+		{8273A6F1-CFC5-4A5E-8B2B-089EA6317312} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
+		{C9E3FDA8-F9A9-48BC-9249-36E86A18D371} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
+		{A81DC2B8-8E3C-442E-B311-A38B22D18DFF} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
+		{1BE88B2D-2A49-47C0-9C60-59D662C0821A} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
+		{47067303-08C7-442D-AEFD-5793595B179F} = {3827E5DC-6235-49F5-80B3-CAFA0AE2D893}
 		{FF061512-7A72-482B-BE37-2F4C73B0D7FE} = {CC781669-0B88-4B87-8440-132EB37FF16D}
 		{3827E5DC-6235-49F5-80B3-CAFA0AE2D893} = {CC781669-0B88-4B87-8440-132EB37FF16D}
+		{402C4B73-F8BD-4806-9A03-5AD21CCFF365} = {CC781669-0B88-4B87-8440-132EB37FF16D}
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {4CCEB7E0-F2FD-41D3-9E4E-BAA95A7FC762}
 	EndGlobalSection
 EndGlobal