• 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
  • ForceOperator
  • 5.0.0

ForceOperator Class

(Automation::ForceOperator)

The ForceOperator forces a signal value. More...

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

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
  • 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 ForceOperator forces a signal value.

A ForceOperator forces default input value. It sets output value to ForceValue if ForceActive is true; otherwise it sets output value to input value.

Arguments

NameDescription
InThe default input value.
OutThe default output value.
ForceActiveEnables or disables forcing the value.
ForceValueThe 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.

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