MovingDelta Class
(Automation::MovingDelta)MovingDelta operator that calculates delta (i.e. difference between min and max) of the input values in the given time window. For signed values the MovingDelta sign also indicates the the delta sign - the delta is positive when the minimum value was found earlier in the history than the maximum, and is negative otherwise. More...
Header: | #include <MovingDelta> |
Inherits: | CDPOperator<T> |
Public Functions
MovingDelta(const CDPPropertyBase &in) | |
virtual | ~MovingDelta() |
Reimplemented Public Functions
virtual void | Configure(XMLPrimitive *operatorXML) override |
virtual void | Create(const char *shortName, CDPBaseObject *parent) override |
virtual unsigned int | Process() override |
- 18 public functions inherited from CDPOperator
- 17 public functions inherited from CDPOperatorBase
- 49 public functions inherited from CDPBaseObject
- 27 public functions inherited from CDP::StudioAPI::CDPNode
- 22 public functions inherited from CDP::StudioAPI::ICDPNode
Additional Inherited Members
- 1 public variable inherited from CDPOperatorBase
- 1 static public member inherited from CDPBaseObject
- 1 protected function inherited from CDP::StudioAPI::CDPNode
- 8 protected variables inherited from CDPOperator
- 5 protected variables inherited from CDPOperatorBase
- 10 protected variables inherited from CDPBaseObject
Detailed Description
MovingDelta operator that calculates delta (i.e. difference between min and max) of the input values in the given time window. For signed values the MovingDelta sign also indicates the the delta sign - the delta is positive when the minimum value was found earlier in the history than the maximum, and is negative otherwise.
Note: MovingDelta is also useful for detecting if the value changes in specified time window - in case there are no changes then the output (delta) will be zero.
Arguments
Name | Description |
---|---|
In | The default input value. |
Out | The default output value. |
Time | Time in seconds to take values into account while calculating the delta. Note: If Time is zero the operator will do no calculation (operator output will be the same as input). Note: If Time is negative the operator will do no calculation and alarm will be reported to parent component. |
Properties
Property | Description |
---|---|
Reset | Clears the calculation. When toggled from 0 to 1 calculation "observation window" is cleared and output is set to input value. |
When operator is used inside a signal its default input is automatically tied to signal's InternalValue or previous operator's output. Its default output is automatically tied to next operator's input or to signal's Value. See also CDP Operator Usage In CDP Signals.
Note: This operator can't be used in I/O Servers / CDPChannels because it requires to be run with a constant period. I/O Servers can't always guarantee periodic running since they may be in Offline state, or they can send/receive on change.
Example
Below is an example plot with Sine(Period=10) signal (cyan) and the same signal with MovingDelta(Time=0.´5) applied (orange):
Actual Processing Code of the MovingMaximum
unsigned int MovingDelta<T>::Process() { auto windowSize = d->valueHistory->GetWindowTime(); if (windowSize < 0.0) { GetParent()->ReportConfigurationFault(this, "Negative window Time"); d->faultReported = true; return STATUS_SIGNAL_FAULT; } if (d->valueHistory->GetReset()) d->valueHistory->Reset(); d->valueHistory->PushValue((T)m_input); m_output = d->CalculateDelta(); return STATUS_OK; }
See also Argument.
Member Function Documentation
MovingDelta::MovingDelta(const CDPPropertyBase &in)
Default constructs an instance of MovingDelta.
[virtual]
MovingDelta::~MovingDelta()
Destroys the instance of MovingDelta. The destructor is virtual.
[override virtual]
void MovingDelta::Configure(XMLPrimitive *operatorXML)
[override virtual]
void MovingDelta::Create(const char *shortName, CDPBaseObject *parent)
[override virtual]
unsigned int MovingDelta::Process()
Get started with CDP Studio today
Let us help you take your great ideas and turn them into the products your customer will love.