Merge pull request #543 from dacky179/feature/GetTaskOfActivity

Add Activity- and ProcessExtensions

Author: Thomas Fuchs

src/Moryx.AbstractionLayer/Activities/ActivityExtensions.cs

@@ -0,0 +1,33 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Moryx.AbstractionLayer.Recipes;
+using Moryx.Workplans;
+
+namespace Moryx.AbstractionLayer
+{
+    /// <summary>
+    /// Extensions for <see cref="Activity"/>
+    /// </summary>
+    public static class ActivityExtensions
+    {
+        /// <summary>
+        /// Get the task of an <see cref="Activity"/>.
+        /// Interface extension for more accessibility and less casting.
+        /// </summary>
+        /// <param name="activity">Must derive from <seealso cref="Activity"/>!</param>
+        public static IWorkplanStep GetTask(this IActivity activity)
+        {
+            if (activity is not Activity cast)
+                throw new ArgumentException("GetTask only works for Activity (IActivity is slightly not enough)!", nameof(activity));
+
+            if (activity.Process.Recipe is WorkplanRecipe workplanRecipe)
+            {
+                var step = workplanRecipe.Workplan.Steps.FirstOrDefault(s => s.Id == cast.StepId);
+                return step;
+            }
+            return null;
+        }
+    }
+}

src/Moryx.AbstractionLayer/Process/ProcessExtensions.cs

@@ -1,26 +1,50 @@
-namespace Moryx.AbstractionLayer
+using System.Collections.Generic;
+
+namespace Moryx.AbstractionLayer
 {
     /// <summary>
     /// Extensions for <see cref="IProcess"/>
     /// </summary>
     public static class ProcessExtensions
     {
         /// <summary>
-        /// Prepared activity that will be dispatched as soon as a ready to work was send.
+        /// Get one prepared activity that will be dispatched as soon as a ready to work was send.
+        /// Mention that, in case of parallel path in a workplan, a process could have multiple prepared activities!
+        /// See also: <seealso cref="NextActivities"/>
         /// </summary>
+        /// <returns>Last activity of the process that is prepared</returns>
         public static IActivity NextActivity(this IProcess process)
         {
             return process.GetActivity(ActivitySelectionType.LastOrDefault, activity => activity.Tracing?.Started == null);
         }
 
         /// <summary>
-        /// Current running activity
+        /// Get all prepared activities that will be dispatched as soon as a ready to work was send.
+        /// </summary>
+        public static IEnumerable<IActivity> NextActivities(this IProcess process)
+        {
+            return process.GetActivities(activity => activity.Tracing?.Started == null);
+        }
+
+        /// <summary>
+        /// Get one of the current running activities of the process. 
+        /// Mention that, in case of parallel path in a workplan, a process could have multiple running activities!
+        /// See also: <seealso cref="CurrentActivities"/>
         /// </summary>
+        /// <returns>Last activity of the process that is running</returns>
         public static IActivity CurrentActivity(this IProcess process)
         {
             return process.GetActivity(ActivitySelectionType.LastOrDefault, activity => activity.Tracing?.Started != null && activity.Result == null);
         }
 
+        /// <summary>
+        /// Get all current running activities of the process.
+        /// </summary>
+        public static IEnumerable<IActivity> CurrentActivities(this IProcess process)
+        {
+            return process.GetActivities(activity => activity.Tracing?.Started != null && activity.Result == null);
+        }
+
         /// <summary>
         /// Get last completed activity
         /// </summary>