MinMaxLimiter Class
(Automation::MinMaxLimiter)A Min/Max limiter operator. More...
Header: | #include <MinMaxLimiter.h> |
Inherits: | CDPOperator<T> |
Public Functions
MinMaxLimiter(const CDPPropertyBase &in) | |
virtual | ~MinMaxLimiter() |
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 Min/Max limiter operator.
This CDP operator can be used to limit (truncate) signal output values.
Arguments
Argument name | Description |
---|---|
Min | Minimum value to limit output to. Values below that will be replaced with Min value in output. |
Max | Maximum value to limit output to. Values above that will be replaced with Max value in output. |
Min and Max arguments can be routed from other signal, parameter or property.
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 MinMaxLimiter(Min=-0.1, Max=0.8) operator applied (orange):
Actual Processing Code of the MinMaxLimiter
unsigned int MinMaxLimiter<T>::Process() { T retval = m_input; if (d->min) { CDPVariantValue min_v = d->min->GetVariantValue(); T min = min_v.GetConvertedValue<T>(); if (retval < min) retval = min; } if (d->max) { CDPVariantValue max_v = d->max->GetVariantValue(); T max = max_v.GetConvertedValue<T>(); if (retval > max) retval = max; } m_output = retval; return STATUS_OK; }
See also Argument.
Member Function Documentation
MinMaxLimiter::MinMaxLimiter(const CDPPropertyBase &in)
Constructs a MinMaxLimiter with input in.
[virtual]
MinMaxLimiter::~MinMaxLimiter()
Destructs the MinMaxLimiter operator
[override virtual]
void MinMaxLimiter::Configure(XMLPrimitive *operatorXML)
Reimplemented from CDPBaseObject::Configure().
[override virtual]
unsigned int MinMaxLimiter::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.