Merge pull request #4 from simatic-ax/refactor_namespces

feat(impl)!: refactor namespaces to reduce complexity
simatic-ax · Aug 11, 2022 · 01d8475 · 01d8475
2 parents 052dc63 + d33e708
commit 01d8475
Show file tree

Hide file tree

Showing 29 changed files with 83 additions and 71 deletions.
diff --git a/doc/sketches.vsd b/doc/sketches.vsd
diff --git a/docs/SortDecissionEvent.md b/docs/SortDecissionEvent.md
@@ -0,0 +1,35 @@
+# SortDecisionEvent
+
+## Description
+A `SortDecisionEvent` is a predefined `ITriggerEvent` that can be used specifically 
+to handle route decisions. Whenever a window passes a virtual trigger (trigger point) 
+that has a `SortDecisionEvent`, it is checked whether the item should trigger an 
+action of the `ExitHandler` at this trigger point.
+Further more before and after the EventHandler, User defined (`IUserDefinedEvent`) events can be executed.
+
+## Public interface:
+|||
+|-|-|
+| SortStrategy : ISortStrategy; | Checks whether an action should be triggered for the item at this trigger point |
+|ExitHandler : IExitPointHandler;|  Action() of the IExitPointHandler is executed when SortStrategy.Check() returns TRUE|
+|EventBefore : IUserDefinedEvent;|  Userdefined event which is called before the Action() of the IExitPointHandler is called |
+|EventAfter : IUserDefinedEvent; | Userdefined event which is called after the Action() of the IExitPointHandler is called |
+
+## Class diagramm
+```mermaid
+classDiagram
+SortDecisionEvent--|>ITriggerEvent
+SortDecisionEvent : SortStrategy ISortStrategy
+SortDecisionEvent : ExitHandler IExitPointHandler
+SortDecisionEvent : EventBefore IUserDefinedEvent
+SortDecisionEvent : EventAfter IUserDefinedEvent
+ITriggerEvent : Action()
+ITriggerEvent : ActionAfter() 
+ISortStrategy..SortDecisionEvent
+ISortStrategy : Check(ITransportWindow, IVirtualTrigger, IExitPointHandler)
+IExitPointHandler..SortDecisionEvent
+IUserDefinedEvent..SortDecisionEvent
+IUserDefinedEvent : EventStatus Action(IVirtualTrigger, ITransportWindow)
+IExitPointHandler : BOOL Ready()
+IExitPointHandler : BOOL Activate()
+```
diff --git a/doc/winconcept.png → docs/winconcept.png b/doc/winconcept.png → docs/winconcept.png
diff --git a/src/EventHandler/EventStatus.st b/src/EventHandler/EventStatus.st
@@ -1,4 +1,4 @@
-NAMESPACE Simatic.Ax.WindowTracking.EventHandler
+NAMESPACE Simatic.Ax.WindowTracking
 
     TYPE
         EventStatus : (Undefined, Finished, Error, NullReference, NotEnabled) := Undefined;

diff --git a/src/EventHandler/ITriggerEvent.st b/src/EventHandler/ITriggerEvent.st
@@ -1,6 +1,4 @@
-USING Simatic.Ax.WindowTracking.Trigger;
-
-NAMESPACE Simatic.Ax.WindowTracking.EventHandler
+NAMESPACE Simatic.Ax.WindowTracking
     INTERFACE ITriggerEvent
         METHOD Action : EventStatus
             VAR_INPUT

diff --git a/src/EventHandler/IUserDefinedEvent.st b/src/EventHandler/IUserDefinedEvent.st
@@ -1,6 +1,4 @@
-USING Simatic.Ax.WindowTracking.Trigger;
-
-NAMESPACE Simatic.Ax.WindowTracking.EventHandler
+NAMESPACE Simatic.Ax.WindowTracking
     INTERFACE IUserDefinedEvent
         METHOD Action : EventStatus
             VAR_INPUT

diff --git a/src/EventHandler/SortDecisionEvent.st b/src/EventHandler/SortDecisionEvent.st
@@ -1,10 +1,20 @@
-USING Simatic.Ax.WindowTracking.EventHandler;
-USING Simatic.Ax.WindowTracking.Trigger;
-USING Simatic.Ax.WindowTracking.SortDecision;
-USING Simatic.Ax.WindowTracking.ExitPointHandler;
-
-NAMESPACE Simatic.Ax.WindowTracking.EventHandler
-    CLASS SortDecisionEvent IMPLEMENTS ITriggerEvent
+NAMESPACE Simatic.Ax.WindowTracking
+/// A sort decision event is a predefined trigger event that can be used specifically 
+/// to handle route decisions. Whenever a window passes a virtual trigger (trigger point) 
+/// that has a `sort decision event`, it is checked whether the item should trigger an 
+/// action at this trigger point. 
+///
+/// Public interface:
+/// SortStrategy : ISortStrategy;   
+///   Checks whether an action should be triggered for the item at this trigger point 
+///
+/// ExitHandler : IExitPointHandler;
+///   Action() of the IExitPointHandler is executed when SortStrategy.Check() returns TRUE
+/// 
+/// EventBefore : IUserDefinedEvent;  Userdefined event which is called before the Action() of the IExitPointHandler is called
+/// EventAfter : IUserDefinedEvent;   Userdefined event which is called after the Action() of the IExitPointHandler is called
+{axcode:docs-v0:@simatic-ax/windowtracking:SortDecissionEvent.md}
+CLASS FINAL SortDecisionEvent IMPLEMENTS ITriggerEvent
 
         VAR PUBLIC
             SortStrategy : ISortStrategy;

diff --git a/src/EventHandler/TerminateWindowEvent.st b/src/EventHandler/TerminateWindowEvent.st
@@ -1,7 +1,5 @@
-USING Simatic.Ax.WindowTracking.Trigger;
-
-NAMESPACE Simatic.Ax.WindowTracking.EventHandler
-    CLASS TerminateWindowEvent IMPLEMENTS ITriggerEvent
+NAMESPACE Simatic.Ax.WindowTracking
+    CLASS FINAL TerminateWindowEvent IMPLEMENTS ITriggerEvent
         VAR PUBLIC
             WindowList : ITransportWindowsTerminate;
             EventBefore : IUserDefinedEvent;

diff --git a/src/Items/IItem.st b/src/Items/IItem.st
@@ -1,6 +1,6 @@
-USING Simatic.Ax.WindowTracking.EventHandler;
-USING Simatic.Ax.WindowTracking.Trigger;
-NAMESPACE Simatic.Ax.WindowTracking.Items
+USING Simatic.Ax.WindowTracking;
+
+NAMESPACE Simatic.Ax.WindowTracking
     INTERFACE IItem
         METHOD GetDestination : IVirtualTrigger
             VAR_INPUT 

diff --git a/src/Items/Item1Destination.st b/src/Items/Item1Destination.st
@@ -1,6 +1,4 @@
-USING Simatic.Ax.WindowTracking.Trigger;
-
-NAMESPACE Simatic.Ax.WindowTracking.Items
+NAMESPACE Simatic.Ax.WindowTracking
     CLASS ItemOneDestination IMPLEMENTS IItem
 
         VAR PUBLIC

diff --git a/src/Others/IExitPointHandler.st b/src/Others/IExitPointHandler.st
@@ -1,4 +1,4 @@
-NAMESPACE Simatic.Ax.WindowTracking.ExitPointHandler
+NAMESPACE Simatic.Ax.WindowTracking
     INTERFACE IExitPointHandler
         METHOD IsReady : BOOL
         END_METHOD

diff --git a/src/Others/ISortStrategy.st b/src/Others/ISortStrategy.st
@@ -1,7 +1,6 @@
-USING Simatic.Ax.WindowTracking.Trigger;
-USING Simatic.Ax.WindowTracking.ExitPointHandler;
+USING Simatic.Ax.WindowTracking;
 
-NAMESPACE Simatic.Ax.WindowTracking.SortDecision
+NAMESPACE Simatic.Ax.WindowTracking
     INTERFACE ISortStrategy
         METHOD Check : BOOL
             VAR_INPUT

diff --git a/src/Others/SortDecisionOneDestination.st b/src/Others/SortDecisionOneDestination.st
@@ -1,8 +1,4 @@
-USING Simatic.Ax.WindowTracking.Items;
-USING Simatic.Ax.WindowTracking.Trigger;
-USING Simatic.Ax.WindowTracking.ExitPointHandler;
-
-NAMESPACE Simatic.Ax.WindowTracking.SortDecision
+NAMESPACE Simatic.Ax.WindowTracking
     CLASS SortDecisionOneDestination IMPLEMENTS ISortStrategy
         VAR PUBLIC
 

diff --git a/src/Trigger/ITriggerList.st b/src/Trigger/ITriggerList.st
@@ -1,4 +1,4 @@
-NAMESPACE Simatic.Ax.WindowTracking.Trigger
+NAMESPACE Simatic.Ax.WindowTracking
     INTERFACE ITriggerList
 
         METHOD Add : BOOL

diff --git a/src/Trigger/IVirtualTrigger.st b/src/Trigger/IVirtualTrigger.st
@@ -1,6 +1,6 @@
-USING Simatic.Ax.WindowTracking.EventHandler;
+USING Simatic.Ax.WindowTracking;
 
-NAMESPACE Simatic.Ax.WindowTracking.Trigger
+NAMESPACE Simatic.Ax.WindowTracking
     INTERFACE IVirtualTrigger
 
         METHOD ActivateEvent : EventStatus

diff --git a/src/Trigger/VirtualTrigger.st b/src/Trigger/VirtualTrigger.st
@@ -1,7 +1,7 @@
-USING Simatic.Ax.WindowTracking.EventHandler;
+USING Simatic.Ax.WindowTracking;
 
-NAMESPACE Simatic.Ax.WindowTracking.Trigger
-    CLASS VirtualTrigger IMPLEMENTS IVirtualTrigger
+NAMESPACE Simatic.Ax.WindowTracking
+    CLASS FINAL VirtualTrigger IMPLEMENTS IVirtualTrigger
 
         VAR PUBLIC
             Position : DINT;

diff --git a/src/Trigger/VirtualTriggerList.st b/src/Trigger/VirtualTriggerList.st
@@ -1,5 +1,5 @@
-NAMESPACE Simatic.Ax.WindowTracking.Trigger
-    CLASS VirtualTriggerList IMPLEMENTS ITriggerList
+NAMESPACE Simatic.Ax.WindowTracking
+    CLASS FINAL VirtualTriggerList IMPLEMENTS ITriggerList
         VAR PUBLIC
             PositiveTolerance : DINT := 5;
             NegativeTolerance : DINT := 5;

diff --git a/src/Window/ITransportWindow.st b/src/Window/ITransportWindow.st
@@ -1,4 +1,3 @@
-USING Simatic.Ax.WindowTracking.Items;
 USING Simatic.Ax.SimpleControlModules;
 
 NAMESPACE Simatic.Ax.WindowTracking

diff --git a/src/Window/ITransportWindowsTerminate.st b/src/Window/ITransportWindowsTerminate.st
@@ -1,6 +1,3 @@
-USING Simatic.Ax.WindowTracking.Trigger;
-USING Simatic.Ax.SimpleControlModules;
-
 NAMESPACE Simatic.Ax.WindowTracking
     INTERFACE ITransportWindowsTerminate
 

diff --git a/src/Window/TransportWindow.st b/src/Window/TransportWindow.st
@@ -1,8 +1,8 @@
 USING Simatic.Ax.SimpleControlModules;
-USING Simatic.Ax.WindowTracking.Items;
+
 NAMESPACE Simatic.Ax.WindowTracking
 
-    CLASS TransportWindow IMPLEMENTS ITransportWindow
+    CLASS FINAL TransportWindow IMPLEMENTS ITransportWindow
         VAR PUBLIC
             Item : IItem;
         END_VAR

diff --git a/src/Window/TransportWindowList.st b/src/Window/TransportWindowList.st
@@ -1,9 +1,7 @@
-USING Simatic.Ax.WindowTracking.Trigger;
 USING Simatic.Ax.SimpleControlModules;
-USING Simatic.Ax.WindowTracking.Items;
 
 NAMESPACE Simatic.Ax.WindowTracking
-    CLASS TransportWindowList IMPLEMENTS ITransportWindowsTerminate
+    CLASS FINAL TransportWindowList IMPLEMENTS ITransportWindowsTerminate
         VAR PUBLIC
             Encoder : IEncoder;
             TriggerPointList : ITriggerList;

diff --git a/test/ItemTest.st b/test/ItemTest.st
@@ -1,8 +1,6 @@
 USING AxUnit.Assert;
-USING AxUnit.Assert;
-USING Simatic.Ax.WindowTracking.Trigger;
 
-NAMESPACE Simatic.Ax.WindowTracking.Items
+NAMESPACE Simatic.Ax.WindowTracking
     {TestFixture}
     CLASS ItemTest
         VAR PROTECTED

diff --git a/test/SortDecisionOneDestinationTest.st b/test/SortDecisionOneDestinationTest.st
@@ -1,10 +1,6 @@
 USING AxUnit.Assert;
-USING Simatic.Ax.WindowTracking.EventHandler;
-USING Simatic.Ax.WindowTracking.Trigger;
-USING Simatic.Ax.WindowTracking.Items;
-USING Simatic.Ax.WindowTracking.ExitPointHandler;
 
-NAMESPACE Simatic.Ax.WindowTracking.SortDecision
+NAMESPACE Simatic.Ax.WindowTracking
     {TestFixture}
     CLASS SortDecisionOneDestinationTest
         VAR PROTECTED

diff --git a/test/TerminateWindowTest.st b/test/TerminateWindowTest.st
@@ -1,8 +1,6 @@
 USING AxUnit.Assert;
-USING Simatic.Ax.WindowTracking.EventHandler;
-USING Simatic.Ax.WindowTracking.Trigger;
 
-NAMESPACE Simatic.Ax.WindowTracking.EventHandler
+NAMESPACE Simatic.Ax.WindowTracking
     {TestFixture}
     CLASS TerminateWindowTest
         VAR PROTECTED

diff --git a/test/TransportWindowTest.st b/test/TransportWindowTest.st
@@ -1,5 +1,4 @@
 USING AxUnit.Assert;
-USING Simatic.Ax.WindowTracking.Trigger;
 USING Simatic.Ax.SimpleControlModules;
 
 

diff --git a/test/TransportWindowsListTest.st b/test/TransportWindowsListTest.st
@@ -1,5 +1,4 @@
 USING AxUnit.Assert;
-USING Simatic.Ax.WindowTracking.Trigger;
 USING Simatic.Ax.SimpleControlModules;
 
 

diff --git a/test/VirtualTriggerListTest.st b/test/VirtualTriggerListTest.st
@@ -1,6 +1,6 @@
-USING Simatic.Ax.WindowTracking.Trigger;
 USING AxUnit.Assert;
-NAMESPACE Simatic.Ax.WindowTracking.Trigger
+
+NAMESPACE Simatic.Ax.WindowTracking
     {TestFixture}
     CLASS TestVirtualTriggerList
         VAR PROTECTED

diff --git a/test/VirtualTriggerTest.st b/test/VirtualTriggerTest.st
@@ -1,7 +1,5 @@
 USING AxUnit.Assert;
-USING Simatic.Ax.WindowTracking.Trigger;
-USING Simatic.Ax.WindowTracking.EventHandler;
-NAMESPACE Simatic.Ax.WindowTracking.Trigger
+NAMESPACE Simatic.Ax.WindowTracking
     {TestFixture}
     CLASS TestVirtualTrigger
         VAR PROTECTED

diff --git a/test/WindowingIntegrativeTest.st b/test/WindowingIntegrativeTest.st
@@ -1,7 +1,5 @@
 USING AxUnit.Assert;
-USING Simatic.Ax.WindowTracking.Trigger;
-USING Simatic.Ax.WindowTracking.EventHandler;
-NAMESPACE Simatic.Ax.WindowTracking.Trigger
+NAMESPACE Simatic.Ax.WindowTracking
     {TestFixture}
     CLASS WindowingIntegraiveTest
         VAR PROTECTED