From b44d41bca2abee3510698c2e6eb6501f6e2debf8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Seidel?= Date: Mon, 21 Nov 2022 17:24:23 +0100 Subject: [PATCH] remove C# comment style --- src/Input/BinSignal.st | 16 ++++---------- src/Input/BinSignalExt.st | 8 +++---- src/Input/DintInput.st | 18 +++++----------- src/Input/InputBase.st | 10 ++------- src/Input/IntInput.st | 16 ++++---------- src/Input/LRealInput.st | 24 +++++++-------------- src/Input/RealInput.st | 18 +++++----------- src/Input/WordInput.st | 22 ++++++++------------ src/Output/BinOutput.st | 44 +++++++++++++++------------------------ src/Output/DWordOutput.st | 12 +++-------- src/Output/DintOutput.st | 14 ++++++------- src/Output/IntOutput.st | 13 ++++-------- src/Output/LIntOutput.st | 13 ++++-------- src/Output/LRealOutput.st | 12 +++-------- src/Output/OutputBase.st | 11 +++------- src/Output/RealOutput.st | 13 ++++-------- src/Output/WordOutput.st | 12 +++-------- 17 files changed, 86 insertions(+), 190 deletions(-) diff --git a/src/Input/BinSignal.st b/src/Input/BinSignal.st index 60cb072..7479e92 100644 --- a/src/Input/BinSignal.st +++ b/src/Input/BinSignal.st @@ -34,30 +34,22 @@ NAMESPACE Simatic.Ax.IO.Input END_METHOD - /// - /// - /// Returns if the signal is inverted + ///Returns if the signal is inverted METHOD PUBLIC IsInverted : BOOL IsInverted := invert; END_METHOD - /// - /// - /// Returns the current status of BinSignal + ///Returns the current status of BinSignal METHOD PUBLIC Q : BOOL Q := _statusQ; END_METHOD - /// - /// - /// Returns if a rising edge was detected in the current cycle + ///Returns if a rising edge was detected in the current cycle METHOD PUBLIC QRis : BOOL QRis := _statusQRis; END_METHOD - /// - /// - /// Returns if a falling edge was detected in the current cycle + ///Returns if a falling edge was detected in the current cycle METHOD PUBLIC QFal : BOOL QFal := _statusQFal; END_METHOD diff --git a/src/Input/BinSignalExt.st b/src/Input/BinSignalExt.st index 9de4120..e37caaf 100644 --- a/src/Input/BinSignalExt.st +++ b/src/Input/BinSignalExt.st @@ -11,12 +11,10 @@ NAMESPACE Simatic.Ax.IO.Input _signalInOld : BOOL; END_VAR - /// /// Read digital signal (must be executed in every cycle - recommendation: begin of cycle in case of digital input signals) - /// - /// Digital/Boolean signal - /// signal is valid (if FALSE, the default value will be used); default = TRUE - /// default value which is used, when valid 0 FALSE + /// Digital/Boolean signal + /// signal is valid (if FALSE, the default value will be used); default = TRUE + /// default value which is used, when valid 0 FALSE METHOD PUBLIC OVERRIDE ReadCyclic VAR_INPUT signal : BOOL; diff --git a/src/Input/DintInput.st b/src/Input/DintInput.st index 27fa981..254a3f7 100644 --- a/src/Input/DintInput.st +++ b/src/Input/DintInput.st @@ -1,7 +1,5 @@ NAMESPACE Simatic.Ax.IO.Input - /// - /// Class to handle DINT input values - /// + /// Class to handle DINT input values CLASS DintInput EXTENDS InputBase VAR PRIVATE @@ -10,20 +8,16 @@ NAMESPACE Simatic.Ax.IO.Input _qBad : BOOL; END_VAR - /// /// The max and min value of datataype Dint - /// VAR CONSTANT PUBLIC MIN : DINT := DINT#-2147483648; MAX : DINT := DINT#2147483647; END_VAR - /// /// Read the input value from Input area of type Double Integer - /// - /// The double integer input value - /// The input value is valid (e.g. periphery is ok) - /// Default value if valid = FALSE + /// The double integer input value + /// The input value is valid (e.g. periphery is ok) + /// Default value if valid = FALSE METHOD PUBLIC ReadCyclic VAR_INPUT value : DINT; @@ -36,10 +30,8 @@ NAMESPACE Simatic.Ax.IO.Input _default := default; END_METHOD - /// /// Returns the actual value of double integer - /// - /// Actual value of the DINT + /// Actual value of the DINT METHOD PUBLIC Q : DINT IF (NOT(THIS.QBad())) THEN Q := _value; diff --git a/src/Input/InputBase.st b/src/Input/InputBase.st index 2669aaa..e1565d2 100644 --- a/src/Input/InputBase.st +++ b/src/Input/InputBase.st @@ -1,16 +1,12 @@ NAMESPACE Simatic.Ax.IO.Input - /// /// QBad-Status of binary input signal - /// CLASS InputBase VAR PROTECTED _isQBad : BOOL; // TRUE : signal is invalid END_VAR - /// /// Set the status to QBad - /// - /// OnDelay value for BinSignal + /// OnDelay value for BinSignal METHOD PROTECTED QBad VAR_INPUT value : BOOL; @@ -18,10 +14,8 @@ NAMESPACE Simatic.Ax.IO.Input _isQBad := value; END_METHOD - /// /// Returns the QBad-Status of BinSignal. If valid = FALSE --> QBad = TRUE - /// - /// The QBad-Status of BinSignal + /// The QBad-Status of BinSignal METHOD PUBLIC QBad : BOOL QBad := _isQBad; ; diff --git a/src/Input/IntInput.st b/src/Input/IntInput.st index 58fc75b..1a0746d 100644 --- a/src/Input/IntInput.st +++ b/src/Input/IntInput.st @@ -1,27 +1,21 @@ NAMESPACE Simatic.Ax.IO.Input - /// /// Class to handle INT input values - /// CLASS IntInput EXTENDS InputBase VAR PRIVATE _value : INT := 0; _default : INT := 0; END_VAR - /// /// The max and min value of datataype int - /// VAR CONSTANT PUBLIC MAX : INT := 32767; MIN : INT := -32768; END_VAR - /// /// Read the input value from Input area of type Integer - /// - /// The integer input value - /// The input value is valid (e.g. periphery is ok) - /// Default value if valid = FALSE + /// The integer input value + /// The input value is valid (e.g. periphery is ok) + /// Default value if valid = FALSE METHOD PUBLIC ReadCyclic VAR_INPUT value : INT; @@ -34,10 +28,8 @@ NAMESPACE Simatic.Ax.IO.Input _default := default; END_METHOD - /// /// Returns the actual value of integer - /// - /// Actual value of the INT + /// Actual value of the INT METHOD PUBLIC Q : Int IF (NOT(THIS.QBad())) THEN Q := _value; diff --git a/src/Input/LRealInput.st b/src/Input/LRealInput.st index cff5dd7..5359e74 100644 --- a/src/Input/LRealInput.st +++ b/src/Input/LRealInput.st @@ -1,7 +1,5 @@ NAMESPACE Simatic.Ax.IO.Input - /// /// Class to handle LREAL input values - /// CLASS LRealInput EXTENDS InputBase VAR PRIVATE @@ -9,20 +7,16 @@ NAMESPACE Simatic.Ax.IO.Input _default : LREAL := LREAL#0.0; END_VAR - /// /// The max and min value of datataype LReal - /// VAR CONSTANT PUBLIC MAX : LREAL := LREAL#1.79769313486231e+308; MIN : LREAL := LREAL#-1.79769313486231e+308; END_VAR - /// /// Read the input value from Input area of type Real - /// - /// The integer input value - /// The input value is valid (e.g. periphery is ok) - /// Default value if valid = FALSE + /// The integer input value + /// The input value is valid (e.g. periphery is ok) + /// Default value if valid = FALSE METHOD PUBLIC ReadCyclic VAR_INPUT value : LWORD; @@ -35,12 +29,10 @@ NAMESPACE Simatic.Ax.IO.Input _default := default; END_METHOD - /// /// Read the input value from Input area of type Real - /// - /// The LREAL input value - /// The input value is valid (e.g. periphery is ok) - /// Default value if valid = FALSE + /// The LREAL input value + /// The input value is valid (e.g. periphery is ok) + /// Default value if valid = FALSE METHOD PUBLIC ReadCyclic VAR_INPUT value : LREAL; @@ -53,10 +45,8 @@ NAMESPACE Simatic.Ax.IO.Input _default := default; END_METHOD - /// /// Returns the actual value of integer - /// - /// Actual value of the LREAL input + /// Actual value of the LREAL input METHOD PUBLIC Q : LREAL IF (NOT(THIS.QBad())) THEN Q := _value; diff --git a/src/Input/RealInput.st b/src/Input/RealInput.st index 7f01c4b..953985b 100644 --- a/src/Input/RealInput.st +++ b/src/Input/RealInput.st @@ -1,7 +1,5 @@ NAMESPACE Simatic.Ax.IO.Input - /// /// Class to handle REAL input values - /// CLASS RealInput EXTENDS InputBase VAR PRIVATE @@ -9,20 +7,16 @@ NAMESPACE Simatic.Ax.IO.Input _default : REAL := REAL#0.0; END_VAR - /// /// The max and min value of datataype LReal - /// VAR CONSTANT PUBLIC MAX : REAL := REAL#+3.402823e+38; MIN : REAL := REAL#-3.402823e+38; END_VAR - - /// + /// Read the input value from Input area of type Real - /// - /// The integer input value - /// The input value is valid (e.g. periphery is ok) - /// Default value if valid = FALSE + /// The integer input value + /// The input value is valid (e.g. periphery is ok) + /// Default value if valid = FALSE METHOD PUBLIC ReadCyclic VAR_INPUT value : DWORD; @@ -35,10 +29,8 @@ NAMESPACE Simatic.Ax.IO.Input _default := default; END_METHOD - /// /// Returns the actual value of integer - /// - /// Actual value of the REAL input + /// Actual value of the REAL input METHOD PUBLIC Q : REAL IF (NOT(THIS.QBad())) THEN Q := _value; diff --git a/src/Input/WordInput.st b/src/Input/WordInput.st index 811adac..936333a 100644 --- a/src/Input/WordInput.st +++ b/src/Input/WordInput.st @@ -1,7 +1,6 @@ NAMESPACE Simatic.Ax.IO.Input - /// - /// Class to handle WORD input values - /// + + /// Class to handle WORD input values CLASS WordInput EXTENDS InputBase VAR PRIVATE @@ -9,20 +8,18 @@ NAMESPACE Simatic.Ax.IO.Input _default : WORD := WORD#16#0; END_VAR - /// + /// The max and min value of datataype word - /// VAR CONSTANT PUBLIC MIN : WORD := WORD#16#0; MAX : WORD := WORD#16#FFFF; END_VAR - /// + /// Read the input value from Input area of type Integer - /// - /// The integer input value - /// The input value is valid (e.g. periphery is ok) - /// Default value if valid = FALSE + /// The integer input value + /// The input value is valid (e.g. periphery is ok) + /// Default value if valid = FALSE METHOD PUBLIC ReadCyclic VAR_INPUT value : WORD; @@ -35,10 +32,9 @@ NAMESPACE Simatic.Ax.IO.Input _default := default; END_METHOD - /// + /// Returns the actual value of integer - /// - /// Actual value of the WORD input + /// Actual value of the WORD input METHOD PUBLIC Q : WORD IF (NOT(THIS.QBad())) THEN Q := _value; diff --git a/src/Output/BinOutput.st b/src/Output/BinOutput.st index be4dc21..a05372f 100644 --- a/src/Output/BinOutput.st +++ b/src/Output/BinOutput.st @@ -1,8 +1,7 @@ NAMESPACE Simatic.Ax.IO.Output - /// + /// Class BinOutput /// An OOP concept to handle digital outputs as a own object - /// CLASS BinOutput IMPLEMENTS IBinOutput VAR _state : BOOL; // internal status @@ -12,11 +11,10 @@ NAMESPACE Simatic.Ax.IO.Output _hasChanged : BOOL; END_VAR - /// + /// Write the internal state to the digital output /// (must be executed in every cycle - recommendation end of cycle) - /// - /// The internal state of the digital output + /// The internal state of the digital output METHOD PUBLIC WriteCyclic VAR_OUTPUT Q : BOOL; @@ -29,10 +27,9 @@ NAMESPACE Simatic.Ax.IO.Output END_METHOD - /// + /// Set the digital output to "value" - /// - /// Value to set + /// Value to set METHOD PUBLIC SetQ VAR_INPUT value : BOOL; @@ -40,55 +37,48 @@ NAMESPACE Simatic.Ax.IO.Output _state := value; END_METHOD - /// + /// Set the digital output to "TRUE" - /// METHOD PUBLIC SetOn _state := TRUE; END_METHOD - /// + /// Set the digital output to "off" - /// METHOD PUBLIC SetOff _state := FALSE; END_METHOD - /// - /// Toggle the digital output to off-->on-->off - /// + + /// Toggle the digital output to off-->on-->off METHOD PUBLIC Toggle _state := NOT(_state); END_METHOD - /// + /// Returns the status of the digital output - /// - /// The status of the digital output + /// The status of the digital output METHOD PUBLIC IsOn : BOOL IsOn := _state; END_METHOD - /// + /// Returns TRUE if the value has changed - /// - /// TRUE if the value has changed + /// TRUE if the value has changed METHOD PUBLIC HasChanged : BOOL HasChanged := _hasChanged; END_METHOD - /// + /// Returns TRUE if the value has switched on - /// - /// TRUE if the value has switched on + /// TRUE if the value has switched on METHOD PUBLIC HasSwitchedOn : BOOL HasSwitchedOn := _switchedOn; END_METHOD - /// + /// Returns TRUE if the value has switched off - /// - /// TRUE if the value has switched off + /// TRUE if the value has switched off METHOD PUBLIC HasSwitchedOff : BOOL HasSwitchedOff := _switchedOff; END_METHOD diff --git a/src/Output/DWordOutput.st b/src/Output/DWordOutput.st index 1eb8e16..5480022 100644 --- a/src/Output/DWordOutput.st +++ b/src/Output/DWordOutput.st @@ -1,18 +1,14 @@ NAMESPACE Simatic.Ax.IO.Output - /// + /// Class to handle double word output values - /// CLASS DWordOutput EXTENDS OutputBase VAR _actualValue : DWORD; _oldValue : DWORD; END_VAR - - /// /// Set the value of class DWordOutput - /// - /// Value to set + /// Value to set METHOD PUBLIC SetValue VAR_INPUT value : DWORD; @@ -20,10 +16,8 @@ NAMESPACE Simatic.Ax.IO.Output _actualValue := value; END_METHOD - /// /// Write the value to the periphery. But class can also be uses for none hardware access - /// - /// The actual value of the DWORD output + /// The actual value of the DWORD output METHOD PUBLIC WriteCyclic VAR_OUTPUT Q : DWORD; diff --git a/src/Output/DintOutput.st b/src/Output/DintOutput.st index 1ae6a97..f48286c 100644 --- a/src/Output/DintOutput.st +++ b/src/Output/DintOutput.st @@ -1,17 +1,16 @@ NAMESPACE Simatic.Ax.IO.Output - /// + /// Class to handle double integer output values - /// + CLASS DintOutput EXTENDS OutputBase VAR _actualValue : DINT; _oldValue : DINT; END_VAR - /// + /// Set the value of class DINTOutput - /// - /// Value to set + /// Value to set METHOD PUBLIC SetValue VAR_INPUT value : DINT; @@ -19,10 +18,9 @@ NAMESPACE Simatic.Ax.IO.Output _actualValue := value; END_METHOD - /// + /// Write the value to the periphery. But class can also be uses for none hardware access - /// - /// The actual value of the DINT output + /// The actual value of the DINT output METHOD PUBLIC WriteCyclic VAR_OUTPUT Q : DINT; diff --git a/src/Output/IntOutput.st b/src/Output/IntOutput.st index 26e70fa..65f734f 100644 --- a/src/Output/IntOutput.st +++ b/src/Output/IntOutput.st @@ -1,18 +1,14 @@ NAMESPACE Simatic.Ax.IO.Output - /// + /// Class to handle integer output values - /// CLASS IntOutput EXTENDS OutputBase VAR _actualValue : INT; _oldValue : INT; END_VAR - - /// /// Set the value of class IntOutput - /// - /// Value to set + /// Value to set METHOD PUBLIC SetValue VAR_INPUT value : INT; @@ -20,10 +16,9 @@ NAMESPACE Simatic.Ax.IO.Output _actualValue := value; END_METHOD - /// + /// Write the value to the periphery. But class can also be uses for none hardware access - /// - /// The actual value of the INT output + /// The actual value of the INT output METHOD PUBLIC WriteCyclic VAR_OUTPUT Q : INT; diff --git a/src/Output/LIntOutput.st b/src/Output/LIntOutput.st index 9473603..77972a9 100644 --- a/src/Output/LIntOutput.st +++ b/src/Output/LIntOutput.st @@ -1,18 +1,14 @@ NAMESPACE Simatic.Ax.IO.Output - /// + /// Class to handle long integer output values - /// CLASS LIntOutput EXTENDS OutputBase VAR _actualValue : LINT; _oldValue : LINT; END_VAR - - /// /// Set the value of class LIntOutput - /// - /// Value to set + /// Value to set METHOD PUBLIC SetValue VAR_INPUT value : LINT; @@ -20,10 +16,9 @@ NAMESPACE Simatic.Ax.IO.Output _actualValue := value; END_METHOD - /// + /// Write the value to the periphery. But class can also be uses for none hardware access - /// - /// The actual value of the LINT output + /// The actual value of the LINT output METHOD PUBLIC WriteCyclic VAR_OUTPUT Q : LINT; diff --git a/src/Output/LRealOutput.st b/src/Output/LRealOutput.st index f75fe30..7312b97 100644 --- a/src/Output/LRealOutput.st +++ b/src/Output/LRealOutput.st @@ -1,18 +1,14 @@ NAMESPACE Simatic.Ax.IO.Output - /// + /// Class to handle long REAL output values - /// CLASS LRealOutput EXTENDS OutputBase VAR _actualValue : LREAL; _oldValue : LREAL; END_VAR - - /// /// Set the value of class LRealOutput - /// - /// Value to set + /// Value to set METHOD PUBLIC SetValue VAR_INPUT value : LREAL; @@ -20,10 +16,8 @@ NAMESPACE Simatic.Ax.IO.Output _actualValue := value; END_METHOD - /// /// Write the value to the periphery. But class can also be uses for none hardware access - /// - /// The actual value of the LREAL output as LWORD + /// The actual value of the LREAL output as LWORD METHOD PUBLIC WriteCyclic VAR_OUTPUT Q : LWORD; diff --git a/src/Output/OutputBase.st b/src/Output/OutputBase.st index e46846c..c6d03e4 100644 --- a/src/Output/OutputBase.st +++ b/src/Output/OutputBase.st @@ -1,24 +1,19 @@ NAMESPACE Simatic.Ax.IO.Output - /// + /// Status of binary output signal - /// CLASS OutputBase VAR _hasChanged : BOOL; END_VAR - /// /// Returns if the value has changed in the last cycle - /// - /// If the value has changed in the last cycle + /// If the value has changed in the last cycle METHOD PUBLIC HasChanged : BOOL HasChanged := _hasChanged; END_METHOD - /// /// Set the status of hasChanged. Must be implemented in the concrete class - /// - /// TRUE if the value has changed + /// TRUE if the value has changed METHOD PROTECTED HasChanged VAR_INPUT value : BOOL; diff --git a/src/Output/RealOutput.st b/src/Output/RealOutput.st index 9027104..bf34f9f 100644 --- a/src/Output/RealOutput.st +++ b/src/Output/RealOutput.st @@ -1,18 +1,14 @@ NAMESPACE Simatic.Ax.IO.Output - /// + /// Class to handle REAL output values - /// CLASS RealOutput EXTENDS OutputBase VAR _actualValue : REAL; _oldValue : REAL; END_VAR - - /// /// Set the value of class RealOutput - /// - /// Value to set + /// Value to set METHOD PUBLIC SetValue VAR_INPUT value : REAL; @@ -20,10 +16,9 @@ NAMESPACE Simatic.Ax.IO.Output _actualValue := value; END_METHOD - /// + /// Write the value to the periphery. But class can also be uses for none hardware access - /// - /// The actual value of the REAL output as DWORD + /// The actual value of the REAL output as DWORD METHOD PUBLIC WriteCyclic VAR_OUTPUT Q : DWORD; diff --git a/src/Output/WordOutput.st b/src/Output/WordOutput.st index 42c9728..2e5d9df 100644 --- a/src/Output/WordOutput.st +++ b/src/Output/WordOutput.st @@ -1,18 +1,14 @@ NAMESPACE Simatic.Ax.IO.Output - /// + /// Class to handle WORD output values - /// CLASS WordOutput EXTENDS OutputBase VAR _actualValue : WORD; _oldValue : WORD; END_VAR - - /// /// Set the value of class WordOutput - /// - /// Value to set + /// Value to set METHOD PUBLIC SetValue VAR_INPUT value : WORD; @@ -20,10 +16,8 @@ NAMESPACE Simatic.Ax.IO.Output _actualValue := value; END_METHOD - /// /// Write the value to the periphery. But class can also be uses for none hardware access - /// - /// The actual value of the WORD output + /// The actual value of the WORD output METHOD PUBLIC WriteCyclic VAR_OUTPUT Q : WORD;