Merge pull request PHOENIXCONTACT#865 from PHOENIXCONTACT/feature/process-engine-context

Renamed ControlSystemAttached/Detached and added ProcessEngineContext

Author: dbeuchler

docs/migrations/v8_to_v10.md

@@ -14,6 +14,11 @@ To reduce the number of API packages and simplify the overall architecture, **Mo
 
 The simulator module has also been renamed, and its namespace and package id have changed accordingly to reflect its new location within Moryx.ControlSystem.
 
+## ProcessEngineContext and ControlSystemAttached/Detached
+
+The methods `ControlSystemAttached` and `ControlSystemDetached` were renamed to `ProcessEngineAttached` and `ProcessEngineDetached` to match the naming of the framework. ControlSystem is a term for multiple modules and components used within the framework (ProcessEngine, SetupProvider, MaterialManager, ...).
+
+The `ProcessEngineContext` was added to the `ProcessEngineAttached` to provide the `Cell` a possibility to gather information from the process engine. The class is empty in 10.0 because it defines only the API. Features are implemented in the next feature-releases of MORYX 10.x.
 
 ## Renamings and Typo-Fixes
 
@@ -29,6 +34,8 @@ The simulator module has also been renamed, and its namespace and package id hav
 - ProcessContext -> ProcessWorkplanContext
 - OperationClassification -> OperationStateClassification
 - OperationClassification.Loading -> OperationStateClassification.Assigning
+- IControlSystemBound.ControlSystemAttached -> ICell.ProcessEngineAttached
+- IControlSystemBound.ControlSystemDetached -> ICell.ProcessEngineDetached
 
 ## Reduction of interfaces
 
@@ -39,6 +46,7 @@ Several interfaces have been removed to streamline the codebase and reduce compl
 - `IProductPartLink`: Replaced with base-class `ProductPartLink`
 - `IConfig`: Replaced with base-class `ConfigBase`
 - `IDatabaseConfig`: Replaced with base-class `DatabaseConfig`
+- `IControlSystemBound`: Merged with `ICell`
 
 ## Method Signature Changes
 

src/Moryx.AbstractionLayer/Resources/Resource.cs

@@ -148,24 +148,16 @@ public override string ToString()
             return $"{Id}:{Name} ({GetType().Name})";
         }
 
-        /// <summary>
-        /// Current capabilities of this resource
-        /// </summary>
-        private ICapabilities _capabilities = NullCapabilities.Instance;
-
         /// <inheritdoc />
         public ICapabilities Capabilities
         {
-            get
-            {
-                return _capabilities;
-            }
+            get;
             protected set
             {
-                _capabilities = value;
-                CapabilitiesChanged?.Invoke(this, _capabilities);
+                field = value;
+                CapabilitiesChanged?.Invoke(this, field);
             }
-        }
+        } = NullCapabilities.Instance;
 
         /// <summary>
         /// <seealso cref="IResource"/>

src/Moryx.ControlSystem.ProcessEngine/Jobs/Setup/SetupJobHandler.cs

@@ -76,7 +76,7 @@ public void Handle(LinkedList<IJobData> newJobs)
         }
 
         /// <summary>
-        /// Creates and inserts setup and/or clean up for the <paramref name="current"/> 
+        /// Creates and inserts setup and/or clean up for the <paramref name="current"/>
         /// job. Returns the next job to be handled.
         /// </summary>
         private LinkedListNode<IJobData> HandleCurrentJob(LinkedList<IJobData> newJobs, LinkedListNode<IJobData> current)
@@ -164,7 +164,7 @@ private ISetupJobData FollowingCleanup(IJobData jobData)
         }
 
         /// <summary>
-        /// Abort the <paramref name="current"/> and all following jobs that would cause the 
+        /// Abort the <paramref name="current"/> and all following jobs that would cause the
         /// same exception during cleanup creation as they share the same recipe
         /// </summary>
         /// <param name="current">The job that caused the exception initially</param>
@@ -220,7 +220,7 @@ private bool RequiresCleanUpCreation(LinkedList<IJobData> newJobs, IJobData curr
         }
 
         /// <summary>
-        /// Abort the <paramref name="current"/> and all previous jobs that would cause the 
+        /// Abort the <paramref name="current"/> and all previous jobs that would cause the
         /// same exception during cleanup creation as they share the same recipe
         /// </summary>
         /// <param name="current">The job that caused the exception initially</param>
@@ -324,12 +324,12 @@ public IReadOnlyList<ICell> Cells(ICapabilities capabilities)
 
         private class CellReference : Cell, ICell
         {
-            public override IEnumerable<Session> ControlSystemAttached()
+            protected override IEnumerable<Session> ProcessEngineAttached()
             {
                 yield break;
             }
 
-            public override IEnumerable<Session> ControlSystemDetached()
+            protected override IEnumerable<Session> ProcessEngineDetached()
             {
                 yield break;
             }

src/Moryx.ControlSystem.ProcessEngine/Processes/CellReference.cs

@@ -26,12 +26,12 @@ public CellReference(long id)
             Id = id;
         }
 
-        public IEnumerable<Session> ControlSystemAttached()
+        public IEnumerable<Session> ProcessEngineAttached(ProcessEngineContext context)
         {
             throw new NotImplementedException();
         }
 
-        public IEnumerable<Session> ControlSystemDetached()
+        public IEnumerable<Session> ProcessEngineDetached()
         {
             throw new NotImplementedException();
         }

src/Moryx.ControlSystem.ProcessEngine/Processes/Implementation/ActivityDispatcher.cs

@@ -91,7 +91,7 @@ public void Start()
                 var cell = _cells[index];
                 try
                 {
-                    sessions[index] = cell.ControlSystemAttached()
+                    sessions[index] = cell.ProcessEngineAttached(new ProcessEngineContext())
                         .Select(session => new ResourceAndSession(cell, session))
                         .ToArray();
                 }
@@ -116,7 +116,7 @@ public void Stop()
             {
                 try
                 {
-                    foreach (var session in cell.ControlSystemDetached().OfType<ActivityCompleted>())
+                    foreach (var session in cell.ProcessEngineDetached().OfType<ActivityCompleted>())
                         HandleActivityCompleted(cell, session);
                 }
                 catch (Exception e)
@@ -206,7 +206,7 @@ private void OnResourcesAdded(object sender, IResource e)
             cell.ActivityCompleted += OnCellActivityCompleted;
 
             // Attach the new cell
-            var sessions = cell.ControlSystemAttached()
+            var sessions = cell.ProcessEngineAttached(new ProcessEngineContext())
                 .Select(s => new ResourceAndSession(cell, s));
             HandleAttachedCells(sessions);
         }

src/Moryx.ControlSystem/Cells/Cell.cs

@@ -3,7 +3,6 @@
 
 using System.ComponentModel;
 using Moryx.AbstractionLayer.Activities;
-using Moryx.AbstractionLayer.Capabilities;
 using Moryx.AbstractionLayer.Resources;
 
 namespace Moryx.ControlSystem.Cells
@@ -14,11 +13,30 @@ namespace Moryx.ControlSystem.Cells
     [Description("Base type for all cells within a production system")]
     public abstract class Cell : Resource, ICell
     {
+        /// <summary>
+        /// Context class used by the process engine to inform cell about updates
+        /// </summary>
+        public ProcessEngineContext ProcessEngineContext { get; private set; }
+
         /// <inheritdoc />
-        public abstract IEnumerable<Session> ControlSystemAttached();
+        IEnumerable<Session> ICell.ProcessEngineAttached(ProcessEngineContext context)
+        {
+            ProcessEngineContext = context;
+            return ProcessEngineAttached();
+        }
+
+        /// <see cref="ICell.ProcessEngineAttached"/>
+        protected abstract IEnumerable<Session> ProcessEngineAttached();
 
         /// <inheritdoc />
-        public abstract IEnumerable<Session> ControlSystemDetached();
+        IEnumerable<Session> ICell.ProcessEngineDetached()
+        {
+            ProcessEngineContext = null;
+            return ProcessEngineDetached();
+        }
+
+        /// <see cref="ICell.ProcessEngineDetached"/>
+        protected abstract IEnumerable<Session> ProcessEngineDetached();
 
         /// <inheritdoc />
         public abstract void StartActivity(ActivityStart activityStart);
@@ -28,20 +46,7 @@ public virtual void ProcessAborting(IActivity affectedActivity) { }
 
         /// <inheritdoc />
         public abstract void SequenceCompleted(SequenceCompleted completed);
-        private ICapabilities _capabilities = NullCapabilities.Instance;
 
-        public ICapabilities Capabilities
-        {
-            get
-            {
-                return _capabilities;
-            }
-            protected set
-            {
-                _capabilities = value;
-                this.CapabilitiesChanged?.Invoke(this, _capabilities);
-            }
-        }
         /// <summary>
         /// Publish a <see cref="ReadyToWork"/> from the resource
         /// </summary>
@@ -75,6 +80,5 @@ public void PublishActivityCompleted(ActivityCompleted activityResult)
 
         /// <inheritdoc />
         public event EventHandler<ActivityCompleted> ActivityCompleted;
-        public event EventHandler<ICapabilities> CapabilitiesChanged;
     }
 }

src/Moryx.ControlSystem/Cells/ICell.cs

@@ -9,8 +9,20 @@ namespace Moryx.ControlSystem.Cells
     /// <summary>
     /// Interface for all cells
     /// </summary>
-    public interface ICell : IResource, IControlSystemBound
+    public interface ICell : IResource
     {
+        /// <summary>
+        /// Called if the process engine  was attached to production cells.
+        /// Can return currently active sessions within the cell
+        /// </summary>
+        IEnumerable<Session> ProcessEngineAttached(ProcessEngineContext context);
+
+        /// <summary>
+        /// Called if the process engine was detached from production cells.
+        /// Can return currently active sessions within the cell
+        /// </summary>
+        IEnumerable<Session> ProcessEngineDetached();
+
         /// <summary>
         /// Start an activity in the cell
         /// </summary>
@@ -23,7 +35,7 @@ public interface ICell : IResource, IControlSystemBound
         void ProcessAborting(IActivity affectedActivity);
 
         /// <summary>
-        /// Callback from the control system, that the sequence was completed
+        /// Callback from the process engine, that the sequence was completed
         /// </summary>
         void SequenceCompleted(SequenceCompleted completed);
 

src/Moryx.ControlSystem/Cells/IControlSystemBound.cs

@@ -0,0 +1,12 @@
+// Copyright (c) 2025, Phoenix Contact GmbH & Co. KG
+// Licensed under the Apache License, Version 2.0
+
+namespace Moryx.ControlSystem.Cells;
+
+/// <summary>
+/// Context class used by the process engine to inform cell about updates
+/// </summary>
+public class ProcessEngineContext
+{
+
+}

src/Moryx.ControlSystem/Cells/ProcessEngineContext.cs

@@ -31,12 +31,12 @@ protected override void OnDispose()
             base.OnDispose();
         }
 
-        public override IEnumerable<Session> ControlSystemAttached()
+        protected override IEnumerable<Session> ProcessEngineAttached()
         {
             yield break;
         }
 
-        public override IEnumerable<Session> ControlSystemDetached()
+        protected override IEnumerable<Session> ProcessEngineDetached()
         {
             yield break;
         }