• Skip to main content
  • Skip to header right navigation
  • Skip to site footer
CDP Studio logo

CDP Studio

The no-code and full-code software development tool for distributed control systems and HMI

  • Doc
  • Why CDP
    • Software developers
    • Automation engineers
    • Managers
  • Products
    • Automation Designer
    • HMI Designer
    • Maritime HMIs
  • Services
  • Use cases
  • Pricing
  • Try CDP

CDP Studio Documentation

  • Framework - Automation
  • SafeValueOperator
  • 5.0.0

SafeValueOperator Class

(Automation::SafeValueOperator)

The SafeValueOperator forces a safe value when necessary. More...

Header: #include <SafeValueOperator>
Inherits: CDPOperator<T>
  • List of all members, including inherited members

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
  • 49 public functions inherited from CDPBaseObject
  • 27 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
  • 10 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

NameDescription
InThe default input value.
OutThe default output value.
SafeValueThe value that is forced on the output when forcing is active and UseLast is not set.
MaskA mask to do bitwise AND with the input. If result != 0 , output value is set to SafeValue
ForcedIndicates whether forcing safe value is enabled.
UseLastWhen value is being forced enables keeping the last operator output.
UseMaskEnables 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.

The content of this document is confidential information not to be published without the consent of CDP Technologies AS.

CDP Technologies AS, www.cdpstudio.com

Get started with CDP Studio today

Let us help you take your great ideas and turn them into the products your customer will love.

Try CDP Studio for free
Why CDP Studio?

CDP Technologies AS
Hundsværgata 8,
P.O. Box 144
6001 Ålesund, Norway

Tel: +47 990 80 900
E-mail: info@cdptech.com

Company

About CDP

Contact us

Services

Partners

Blog

Developers

Get started

User manuals

Support

Document download

Release notes

My account

Follow CDP

  • LinkedIn
  • YouTube
  • GitHub

© Copyright 2025 CDP Technologies. Privacy and cookie policy.

Return to top