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

PWMOperator Class

(Automation::PWMOperator)

The PWMOperator encodes input value into a pulse width modulated bool output value. More...

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

Public Functions

PWMOperator(const CDPPropertyBase &in)

Reimplemented Public Functions

virtual void Configure(XMLPrimitive *operatorXML) 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

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 PWMOperator encodes input value into a pulse width modulated bool output value.

Pulse-width modulation (PWM) is a modulation technique used to encode a message into a pulsing value. Its main use is to allow the control of the power supplied to electrical devices, such as motors.

If input <= MinInput then the output bool value is false. If input >= MaxInput then the output bool value is true. For input value X between MinInput and MaxInput, output is a pulsing value that is true X percent of time.

Arguments

NameDescription
OutThe default output representing the Pulse-width modulation of input value.
InThe default input. Duty cycle. Should be between MinInput and MaxInput.
MinInputMinimum input value which means output signal is always false.
MaxInputMaximum input value which means output signal is always true.
ResolutionMaximum number of pulses that can be packed into a PWM period. For example, if Resolution is 5 then input value step is 20 (100 divided by 5). Increasing input by less than 20 makes no difference to output.

Note: When using PWMOperator, it is recommended to set your component fs Property to at least 1000 Hz (or use a lower Resolution). Otherwise pulsing output might be too slow for smooth operation of a motor.

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 PWMOperator

unsigned int PWMOperator::Process()
{
  if (!m_minInput || !m_maxInput || !m_pwmResolution)
    return STATUS_ERROR;

  double input = m_input.GetVariantValue().GetConvertedValue<double>();
  input = std::max<double>(input, (double)*m_minInput);
  input = std::min<double>(input, (double)*m_maxInput);
  double dutyCycle = (*m_maxInput - static_cast<double>(*m_minInput))?(input - *m_minInput) / (*m_maxInput - static_cast<double>(*m_minInput)) : 0.0;

  ++m_counter;
  if (m_counter == *m_pwmResolution)
    m_counter = 0;

  if (m_counter < dutyCycle * *m_pwmResolution)
    m_output = 1;
  else
    m_output = 0;

  return STATUS_OK;
}

See also Argument.

Member Function Documentation

PWMOperator::PWMOperator(const CDPPropertyBase &in)

Constructs a PWMOperator.

[override virtual] void PWMOperator::Configure(XMLPrimitive *operatorXML)

Reimplemented from CDPBaseObject::Configure().

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

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