MovingMaximum Class
(Automation::MovingMaximum)MovingMaximum operator that calculates maximum value of the input in the given timeframe. More...
Header: | #include <MovingMaximum.h> |
Inherits: | CDPOperator<T> |
Public Functions
MovingMaximum(const CDPPropertyBase &in) | |
virtual | ~MovingMaximum() |
Reimplemented Public Functions
virtual void | Configure(XMLPrimitive *operatorXML) override |
virtual void | Create(const char *shortName, CDPBaseObject *pParent) override |
virtual void | FillNodeChildren(CDP::StudioAPI::NodeStream &stream) const override |
virtual unsigned int | Process() override |
- 18 public functions inherited from CDPOperator
- 17 public functions inherited from CDPOperatorBase
- 46 public functions inherited from CDPBaseObject
- 26 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
- 11 protected variables inherited from CDPBaseObject
Detailed Description
MovingMaximum operator that calculates maximum value of the input in the given timeframe.
Arguments
Name | Description |
---|---|
In | The default input value. |
Out | The default output value. |
Time | Time in seconds to take values into account while calculating maximum. Note: If Time is zero the operator will do no calcluation (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 MovingMaximum(Time=5) applied (orange):
Actual Processing Code of the MovingMaximum
unsigned int MovingMaximum<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->CalculateMaximum((T)m_input); return STATUS_OK; }
See also Argument.
Member Function Documentation
MovingMaximum::MovingMaximum(const CDPPropertyBase &in)
Constructs a MovingMaximum with input in.
[virtual]
MovingMaximum::~MovingMaximum()
Destructs the MovingMaximum operator
[override virtual]
void MovingMaximum::Configure(XMLPrimitive *operatorXML)
Reimplemented from CDPBaseObject::Configure().
[override virtual]
void MovingMaximum::Create(const char *shortName, CDPBaseObject *pParent)
Reimplemented from CDPBaseObject::Create().
[override virtual]
void MovingMaximum::FillNodeChildren(CDP::StudioAPI::NodeStream &stream) const
Reimplemented from CDPNode::FillNodeChildren().
Exposes himself and Arguments to Studio
[override virtual]
unsigned int MovingMaximum::Process()
Reimplemented from CDPOperatorBase::Process().
Returns STATUS_OK.
Get started with CDP Studio today
Let us help you take your great ideas and turn them into the products your customer will love.