Comments added, namespace TimeProviders removed

Author: jgsiemens

src/Controllers/IDynamicController.st

@@ -1,6 +1,8 @@
 NAMESPACE Simatic.Ax.Dynamics
     INTERFACE IDynamicController
 
+        /// Pass process value and input
+        /// Get next output
         METHOD Next : LREAL 
             VAR_INPUT
                 value : LREAL;

src/Dynamics/Amplifier.st

@@ -1,15 +1,16 @@
 NAMESPACE Simatic.Ax.Dynamics
     CLASS Amplifier IMPLEMENTS IDynamic
 
+        /// Amplification
         VAR PUBLIC
             k : LREAL := 1.0;
         END_VAR
 
-        // Get K
+        /// Get amplification
         METHOD PUBLIC GetK : LREAL
             GetK := k;
         END_METHOD
-        // Set K
+        /// Set ampflification
         METHOD PUBLIC SetK 
             VAR_INPUT 
                 newK : LREAL;

src/Dynamics/Differentiator.st

@@ -2,22 +2,27 @@ NAMESPACE Simatic.Ax.Dynamics
     CLASS Differentiator EXTENDS FirstOrderDynamic
 
         VAR PUBLIC 
+            /// Lead time in seconds
             tDSeconds : LREAL;
         END_VAR
 
         VAR PRIVATE 
             _value : LREAL;
         END_VAR
 
+        /// Get lead time in seconds
         METHOD PUBLIC GetTDSeconds : LREAL
             GetTDSeconds := tDSeconds;
         END_METHOD
+        /// Set lead time in seconds
         METHOD PUBLIC SetTDSeconds
             VAR_INPUT 
                 newTDSeconds : LREAL;
             END_VAR
             tDSeconds := newTDSeconds;
         END_METHOD  
+        /// Set lead time in seconds and amplification
+        /// SetTDSeconds(newTDSeconds, k) is equivalent to SetTDSeconds(newTDSeconds * k)
         METHOD PUBLIC SetTDSeconds
             VAR_INPUT 
                 newTDSeconds : LREAL;
@@ -26,6 +31,7 @@ NAMESPACE Simatic.Ax.Dynamics
             THIS.SetTDSeconds(newTDSeconds * k);
         END_METHOD   
 
+        /// Get last process value
         METHOD INTERNAL GetValue : LREAL
             GetValue := _value;
         END_METHOD

src/Dynamics/FirstOrderDynamic.st

@@ -1,11 +1,17 @@
-USING TimeProviders;
 NAMESPACE Simatic.Ax.Dynamics
+    /// Dynamic exploiting the elapsed time since last call
+    /// `elapsedTimeProvider` must be given!
     CLASS INTERNAL ABSTRACT FirstOrderDynamic IMPLEMENTS IDynamic
 
         VAR PUBLIC 
+            /// Provides elapsed time since last call to `Next()`
+            /// `elapsedTimeProvider.Start()` will be called automatically on `Next()`
+            /// User should never call `elapsedTimeProvider.Start()`!
+            /// Unexpected behaviour could be the result.
             elapsedTimeProvider : IElapsedSecondsProvider;
         END_VAR
 
+        /// Maps the process value and the elapsed time in seconds to the next output value
         METHOD PROTECTED ABSTRACT _Next : LREAL
             VAR_INPUT
                 value : LREAL;

src/Dynamics/FirstOrderOutputDynamic.st

@@ -1,4 +1,6 @@
 NAMESPACE Simatic.Ax.Dynamics
+    /// Dynamic exploiting the elapsed time since last call and last output value
+    /// `elapsedTimeProvider` must be given!
     CLASS INTERNAL ABSTRACT FirstOrderOutputDynamic EXTENDS FirstOrderDynamic IMPLEMENTS IOutputDynamic
 
         VAR PRIVATE
@@ -16,6 +18,7 @@ NAMESPACE Simatic.Ax.Dynamics
             SetOutput := _output;
         END_METHOD
 
+        /// Maps process value, elapsed time since last call and last output value to next output value
         METHOD PROTECTED ABSTRACT _Next : LREAL
             VAR_INPUT
                 value : LREAL;

src/Dynamics/IDynamic.st

@@ -1,6 +1,10 @@
 NAMESPACE Simatic.Ax.Dynamics
+
+    /// `Next(value)`
     INTERFACE IDynamic
 
+        /// Pass process value 
+        /// Get next output
         METHOD Next : LREAL 
             VAR_INPUT
                 value : LREAL;

src/Dynamics/IOutputDynamic.st

@@ -1,5 +1,8 @@
 NAMESPACE Simatic.Ax.Dynamics
+    /// `SetOutput`, extends `IDynamic, IOutputProvider`
     INTERFACE IOutputDynamic EXTENDS IDynamic, IOutputProvider
+        /// Set output value
+        /// New value should be used as base for next output
         METHOD SetOutput : LREAL
             VAR_INPUT
                 output : LREAL;

src/Dynamics/ParallelFirstOrderDynamic.st

@@ -1,31 +1,39 @@
-USING TimeProviders;
-USING TimeProviders;
 NAMESPACE Simatic.Ax.Dynamics
+    /// The process value is passed to two first order dynamics. 
+    /// The output values are summed up and multiplied by the factor K.
     CLASS INTERNAL ABSTRACT ParallelFirstOrderDynamic EXTENDS FirstOrderDynamic
 
         VAR PUBLIC
+            /// The factor K
             k : LREAL := 1.0;
         END_VAR
 
         VAR PROTECTED
+            /// Provides the time of the real time provider in the moment of the call to next. 
+            /// The use of a pseudo time provider ensures the same elapsed time is used by both dynamics. 
+            /// Moreover, time is saved by not calling the measuring function twice. 
             _pseudoTimeProvider : ConstantTimeProvider;
         END_VAR
 
+        /// Get the factor K
         METHOD PUBLIC GetK : LREAL
             GetK := k;
         END_METHOD
+        /// Set the factor K
         METHOD PUBLIC SetK 
             VAR_INPUT 
                 newK : LREAL;
             END_VAR
             k := newK;
         END_METHOD
 
+        /// The method `Next` of one dynamic
         METHOD PROTECTED ABSTRACT _Next0 : LREAL
             VAR_INPUT 
                 value : LREAL;
             END_VAR
         END_METHOD
+        /// The method `Next` of the other dynamic
         METHOD PROTECTED ABSTRACT _Next1 : LREAL
             VAR_INPUT 
                 value : LREAL;

src/TimeProviders/IOutputProvider.st src/IOutputProvider.stsrc/TimeProviders/IOutputProvider.st renamed to src/IOutputProvider.st

@@ -1,5 +1,7 @@
 NAMESPACE Simatic.Ax.Dynamics 
+    /// `GetOutput`
     INTERFACE IOutputProvider
+        /// Get current output value
         METHOD GetOutput : LREAL END_METHOD
     END_INTERFACE
 END_NAMESPACE

src/Signals/ConstantSignal.st

@@ -1,13 +1,17 @@
 NAMESPACE Simatic.Ax.Dynamics
+    /// Constantly provides `output`
     CLASS ConstantSignal IMPLEMENTS IOutputSignal
 
         VAR PUBLIC 
+            /// The output value
             output : LREAL;
         END_VAR
 
         METHOD PUBLIC GetOutput : LREAL
             GetOutput := output;
         END_METHOD  
+
+        /// Set the output value
         METHOD PUBLIC SetOutput : LREAL
             VAR_INPUT 
                 newOutput : LREAL;