Delay Class
(Automation::Delay)A value delay operator. More...
Header: | #include <Delay.h> |
Inherits: | CDPOperator<T> |
Public Functions
Reimplemented Public Functions
- 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
A value delay operator.
This CDP operator can be used to buffer and delay output value by a configurable amount of time.
For example DelayTime=0.005 can be used to delay a value by 5 milliseconds.
Arguments
Name | Description |
---|---|
In | The default input value. |
Out | The default output value. |
DelayTime | Time in seconds to buffer and delay the input signal before sending it to output NB! If DelayTime is negative the operator will not calculate output and will report error to parent component. |
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.
Example
Below is an example plot with Sine signal (cyan) and the same signal with Delay operator applied (orange):
Actual Processing Code of the Delay
unsigned int Delay<T>::Process() { double delay=0.0; if (d->delayTime) { CDPVariantValue delayTime_v = d->delayTime->GetVariantValue(); delay = delayTime_v.GetConvertedValue<double>(); if (delay < 0.0) { GetParent()->ReportConfigurationFault(this, "Negative DelayTime"); d->faultReported = true; return STATUS_SIGNAL_FAULT; } } d->PushCurrentValueToBuffer((T)m_input); m_output = d->PopDelayedValueFromBuffer((T)m_input, delay, this->GetOperatorPeriod()); if (d->faultReported) { GetParent()->ClearConfigurationFault(this); d->faultReported = false; } return STATUS_OK; }
See also Argument.
Member Function Documentation
Delay::Delay(const CDPPropertyBase &in)
Constructs a Delay with input in.
[virtual]
Delay::~Delay()
Destructs the Delay operator
[override virtual]
void Delay::Configure(XMLPrimitive *operatorXML)
Reimplemented from CDPBaseObject::Configure().
[override virtual]
unsigned int Delay::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.