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

InterlockOperator Class

(Automation::InterlockOperator)

The InterlockOperator overrides output to Set value if comparisson evaluates to true instead of input value. More...

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

Public Functions

InterlockOperator(const CDPPropertyBase &in)
virtual ~InterlockOperator()

Reimplemented Public Functions

virtual void Configure(XMLPrimitive *pObjectXML) override
virtual void Create(const char *shortName, CDPBaseObject *parent) override
virtual unsigned int Process() 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

Protected Functions

bool isForced() const
  • 1 protected function inherited from CDP::StudioAPI::CDPNode

Additional Inherited Members

  • 1 public variable inherited from CDPOperatorBase
  • 1 static public member inherited from CDPBaseObject
  • 8 protected variables inherited from CDPOperator
  • 5 protected variables inherited from CDPOperatorBase
  • 10 protected variables inherited from CDPBaseObject

Detailed Description

The InterlockOperator overrides output to Set value if comparisson evaluates to true instead of input value.

An InterlockOperator sets the output value depending on the 'Comparator' and CompareLeft/CompareRight values. It sets output value to Set value if CompareLeft and CompareRight comparisson expression is true, otherwise it sets output value to input value.

Properties and Arguments

NameDescription
ComparatorWhich comparator the interlock operator should use from selection
InThe default input value.
OutThe default output value.
SetThe value to set into the output value when comparisson expression is true.
CompareLeftThe compare value on the Left side of the Comparator
CompareRightThe compare value on the right side of the Comparator

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 InterlockOperator

unsigned int InterlockOperator<T>::Process()
{
  if (!d->setValue || !d->compareLeft || !d->compareRight)
    return STATUS_ERROR;

  if(!isForced())
  {
    this->m_output = static_cast<T>(this->m_input);
    return STATUS_OK;
  }
  else
  {
    this->m_output = static_cast<T>(*(d->setValue));
    return STATUS_VALUE_FORCED;
  }
}

See also Argument.

Member Function Documentation

InterlockOperator::InterlockOperator(const CDPPropertyBase &in)

Default constructs an instance of InterlockOperator.

[virtual] InterlockOperator::~InterlockOperator()

Destructs the instance.

[override virtual] void InterlockOperator::Configure(XMLPrimitive *pObjectXML)

Reimplemented from CDPBaseObject::Configure().

[override virtual] void InterlockOperator::Create(const char *shortName, CDPBaseObject *parent)

Reimplemented from CDPBaseObject::Create().

[override virtual] unsigned int InterlockOperator::Process()

Reimplemented from CDPOperatorBase::Process().

Returns STATUS_VALUE_FORCED if comparisson expression is true; otherwise returns STATUS_OK.

[protected] bool InterlockOperator::isForced() const

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