OffsetOperator Class
(Automation::OffsetOperator)The OffsetOperator applies a constant add operation on object's value. More...
| Header: | #include <OffsetOperator.h> |
| Inherits: | CDPOperator<T> |
Public Functions
| OffsetOperator(const CDPPropertyBase &in) | |
| ~OffsetOperator() |
Reimplemented Public Functions
| virtual void | Create(const char *shortName, CDPBaseObject *parent) override |
| virtual void | FillNodeChildren(CDP::StudioAPI::NodeStream &serializer) const |
| 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 OffsetOperator applies a constant add operation on object's value.
Properties
| Property | Description |
|---|---|
| Offset | Specifies the Offset to add. Offset type is the same as operator's type. |
Arguments
| Name | Description |
|---|---|
| Out | The default output value. |
| In | The default input 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.
Actual Processing Code of the OffsetOperator
unsigned int OffsetOperator<T>::Process() { m_output = (T)m_input + (T)m_offset; return STATUS_OK; }
See also Argument.
Member Function Documentation
OffsetOperator::OffsetOperator(const CDPPropertyBase &in)
Constructs an OffsetOperator with input in.
OffsetOperator::~OffsetOperator()
Destructs the instance.
[override virtual] void OffsetOperator::Create(const char *shortName, CDPBaseObject *parent)
Reimplemented from CDPBaseObject::Create().
[virtual] void OffsetOperator::FillNodeChildren(CDP::StudioAPI::NodeStream &serializer) const
Reimplemented from CDPNode::FillNodeChildren().
[override virtual] unsigned int OffsetOperator::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.