ForceOperator Class
(Automation::ForceOperator)The ForceOperator forces a signal value. More...
Header: | #include <ForceOperator.h> |
Inherits: | CDPOperator<T> |
Public Functions
ForceOperator(const CDPPropertyBase &in) | |
virtual | ~ForceOperator() |
Reimplemented Public Functions
virtual void | Configure(XMLPrimitive *pObjectXML) override |
virtual void | Destroy() override |
virtual unsigned int | Process() override |
virtual unsigned int | Status() const 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 ForceOperator forces a signal value.
A ForceOperator forces default input value. It sets output value to ForceValue if FourceActive is true
; otherwise it sets output value to input value.
Arguments
Name | Description |
---|---|
In | The default input value. |
Out | The default output value. |
ForceActive | Enables or disables forcing the value. |
ForceValue | The value that is forced on the signal. |
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 ForceOperator
unsigned int ForceOperator<T>::Process() { if (!d->forceValue || !d->forceActive) { if(Status()!=STATUS_ERROR) if (auto parent = GetParent()) parent->RunInComponentThread([=](){ parent->UpdateStatus(GetNodeID(), STATUS_ERROR); }); return STATUS_ERROR; } if(!static_cast<bool>(*(d->forceActive))) { // input and output are the same actually. this->m_output = static_cast<T>(this->m_input); if(Status()!=STATUS_OK) if (auto parent = GetParent()) parent->RunInComponentThread([=](){ parent->RemoveStatus(GetNodeID()); }); return STATUS_OK; } else { this->m_output = static_cast<T>(*(d->forceValue)); if(Status()!=STATUS_VALUE_FORCED) if (auto parent = GetParent()) parent->RunInComponentThread([=](){ parent->UpdateStatus(GetNodeID(), STATUS_VALUE_FORCED); }); return STATUS_VALUE_FORCED; } }
See also Argument.
Member Function Documentation
ForceOperator::ForceOperator(const CDPPropertyBase &in)
Constructs a ForceOperator with input in.
[virtual]
ForceOperator::~ForceOperator()
Destructs the instance.
[override virtual]
void ForceOperator::Configure(XMLPrimitive *pObjectXML)
Reimplemented from CDPBaseObject::Configure().
[override virtual]
void ForceOperator::Destroy()
[override virtual]
unsigned int ForceOperator::Process()
Reimplemented from CDPOperatorBase::Process().
Returns STATUS_ERROR if any of ForceValue or ForceActive arguments are missing, STATUS_VALUE_FORCED if ForceActive is true
, otherwise returns STATUS_OK.
[override virtual]
unsigned int ForceOperator::Status() const
Reimplemented from CDPBaseObject::Status().
Returns STATUS_ERROR if ForceValue or ForceActive arguments are missing, STATUS_VALUE_FORCED if ForceActive is true
, otherwise it 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.