MODOperator Class
(Automation::MODOperator)The MODOperator applies Modulo Division on the input by Divisor so that the output value becomes the remainder of the division. More...
Header: | #include <MODOperator.h> |
Inherits: | CDPOperator<T> |
Public Functions
MODOperator(const CDPPropertyBase &in) |
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
The MODOperator applies Modulo Division on the input by Divisor so that the output value becomes the remainder of the division.
Arguments
Name | Description |
---|---|
In | The default input value representing the dividend. |
Out | The default output value representing the remainder. |
Divisor | Divisor used on input to produce the remainder. When Divisor is 0 output is not calculated. |
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
Add a MODOperator<unsigned short> into a Signal<unsigned short> in Configure mode. Then go into the MODOperator that was added, and set Divisor to 2.
How to Run the Example
To run the example from CDP Studio, open Welcome mode and find it under Examples. Next, in Configure mode right-click on the system project and select Run & Connect. See the Running the Example Project tutorial for more information.
Set the signal Value containing the ROL operator to 9, and verify that the value after the operator has been applied becomes 1.
Actual Processing Code of the MODOperator
unsigned int MODOperator<T>::Process() { if (!m_divisor) return STATUS_ERROR; T input = static_cast<T>(m_input); if(static_cast<T>(*m_divisor)!=0) m_output = input%static_cast<T>(*m_divisor); return STATUS_OK; }
See also Argument.
Member Function Documentation
MODOperator::MODOperator(const CDPPropertyBase &in)
Default constructs an instance of MODOperator.
[override virtual]
void MODOperator::Configure(XMLPrimitive *operatorXML)
[override virtual]
unsigned int MODOperator::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.