DivOperator Class
(Automation::DivOperator)The DivOperator divides default input value by arguments. More...
Header: | #include <DivOperator.h> |
Inherits: | CDPOperator<T> |
Public Functions
DivOperator(const CDPPropertyBase &in) |
Reimplemented Public Functions
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
The DivOperator divides default input value by arguments.
This CDP operator can be used to divide the input value by an unlimited number of arguments.
NB! If any argument value is 0, the operator will not calculate output and will report error to parent component.
Arguments
Name | Description |
---|---|
In0 | The default input value. |
Out | The default output 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.
Example
Below is an example plot with Sine signal (cyan) and the same signal with DivOperator(Argument=2.0) applied (orange):
Actual Processing Code of the DivOperator
unsigned int DivOperator<T>::Process() { T v = static_cast<T>(m_input); for (auto arg : this->m_arguments) { T argval = static_cast<T>(*arg); if (argval == static_cast<T>(0)) { GetParent()->ReportConfigurationFault(this, "Averted division by zero"); m_faultReported = true; return STATUS_SIGNAL_FAULT; } v/=argval; } m_output = v; if (m_faultReported) { GetParent()->ClearConfigurationFault(this); m_faultReported = false; } return STATUS_OK; }
See also Argument.
Member Function Documentation
DivOperator::DivOperator(const CDPPropertyBase &in)
Default constructs an instance of DivOperator.
[override virtual]
unsigned int DivOperator::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.