ROROperator Class
(Automation::ROROperator)The ROROperator rotates bits in a value to the right right by Amount. More...
Header: | #include <ROROperator.h> |
Inherits: | CDPOperator<T> |
Public Functions
ROROperator(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 ROROperator rotates bits in a value to the right right by Amount.
The bits rotated out to the right, are rotated back in from the left. In other words, when rotating 1 bit right, the least significant bit becomes the most significant bit, and all the other bits move one bit to the right.
Arguments
Name | Description |
---|---|
In | The default input value to rotate. |
Out | The default output value after rotating. |
Amount | Specifies the amount of bits to rotate. |
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
To rotate a signal value 4 bits to the right, add a ROROperator<unsigned short> into a Signal<unsigned short> in Configure mode. Then go into the ROROperator that was added, and set Amount to 4.
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 ROR operator to 0x000f (15), and verify that the value after the operator has been applied becomes 0xf000(61440)
Actual Processing Code of the ROROperator
unsigned int ROROperator<T>::Process() { if (!m_amountToRotate) return STATUS_ERROR; const T input = static_cast<T>(m_input); uint64_t shift_amount = static_cast<T>(*m_amountToRotate); uint64_t leftshift_val = (m_bitSize-shift_amount) % m_bitSize; uint64_t lower = input >> shift_amount; uint64_t upper = input << leftshift_val; m_output = static_cast<T>(upper | lower); return STATUS_OK; }
See also Argument.
Member Function Documentation
ROROperator::ROROperator(const CDPPropertyBase &in)
Default constructs an instance of ROROperator.
[override virtual]
void ROROperator::Configure(XMLPrimitive *operatorXML)
[override virtual]
unsigned int ROROperator::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.