SafeValueOperator Class
(Automation::SafeValueOperator)The SafeValueOperator forces a safe value when necessary. More...
Header: | #include <SafeValueOperator.h> |
Inherits: | CDPOperator<T> |
Public Functions
SafeValueOperator(const CDPPropertyBase &in) | |
virtual | ~SafeValueOperator() |
Reimplemented Public Functions
virtual void | Configure(XMLPrimitive *operatorXML) override |
virtual void | Create(const char *shortName, CDPBaseObject *parent) 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 SafeValueOperator forces a safe value when necessary.
A SafeValueOperator forces a safe value when when parent signal routing is invalid. It also forces a safe value when masked input value is not 0
if UseMask is true
; otherwise it forces a safe value when signal routing is invalid. A SafeValueOperator sets signal output value to its last value if UseLast is true
; otherwise it sets signal output value to SafeValue. In all the other cases signal output value is set to input value.
Arguments
Name | Description |
---|---|
In | The default input value. |
Out | The default output value. |
SafeValue | The value that is forced on the output when forcing is active and UseLast is not set. |
Mask | A mask to do bitwise AND with the input. If result != 0 , output value is set to SafeValue |
Forced | Indicates whether forcing safe value is enabled. |
UseLast | When value is being forced enables keeping the last operator output. |
UseMask | Enables or disables using Mask. |
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 SafeValueOperator
unsigned int SafeValueOperator<T>::Process() { if (!d->safeValue || !d->signalMask || !d->valueForced || !d->useLastValue || !d->useMask) return STATUS_ERROR; if(*d->useMask) d->SetValueOKBasedOnInputAndMask(); else if(d->signal!=NULL) { CDPPropertyBase::RoutingStatus_e eStat = d->signal->GetRoutingStatus(); if(eStat==CDPPropertyBase::e_NotRouted || eStat==CDPPropertyBase::e_Routed) *d->valueForced = false; else *d->valueForced = true; } if(!*d->valueForced) { m_output = static_cast<T>(m_input); if(Status()!=STATUS_OK) if (auto parent = GetParent()) parent->RunInComponentThread([=](){ parent->RemoveStatus(GetNodeID()); }); } else if(!*d->useLastValue) { m_output = static_cast<T>(*d->safeValue); if(Status()!=STATUS_SIGNAL_FAULT) if (auto parent = GetParent()) parent->RunInComponentThread([=](){ parent->UpdateStatus(GetNodeID(), STATUS_SIGNAL_FAULT); }); } return Status(); }
See also Argument.
Member Function Documentation
SafeValueOperator::SafeValueOperator(const CDPPropertyBase &in)
Constructs a SafeValueOperator with input in.
[virtual]
SafeValueOperator::~SafeValueOperator()
Destructs the SafeValue operator
[override virtual]
void SafeValueOperator::Configure(XMLPrimitive *operatorXML)
Reimplemented from CDPBaseObject::Configure().
[override virtual]
void SafeValueOperator::Create(const char *shortName, CDPBaseObject *parent)
Reimplemented from CDPBaseObject::Create().
[override virtual]
void SafeValueOperator::Destroy()
[override virtual]
unsigned int SafeValueOperator::Process()
Reimplemented from CDPOperatorBase::Process().
Returns STATUS_SIGNAL_FAULT if ForceActive is true
; otherwise returns STATUS_OK.
[override virtual]
unsigned int SafeValueOperator::Status() const
Reimplemented from CDPBaseObject::Status().
Returns STATUS_SIGNAL_FAULT if ForceActive is true
; otherwise 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.