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

RampFilter Class

(Automation::RampFilter)

Ramp filter limits the rate of change on input value by given MaxRate to produce output. More...

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

Public Functions

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

Reimplemented Public Functions

virtual void Configure(XMLPrimitive *operatorXML) override
virtual void Create(const char *shortName, CDPBaseObject *pParent) override
virtual void Init() 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

Ramp filter limits the rate of change on input value by given MaxRate to produce output.

This CDP operator limits how fast a signal is allowed to change (limits the first derivative). The Ramp filter operator output value always changes towards input value but do it never faster than the maximum allowed value change speed.

Properties

PropertyDescription
ResetResets RampFilter calculation. When toggled from 0 to 1 RampFilter signal change history is cleared.

Arguments

NameDescription
OutThe default output. The change rate limited value.
InThe default input. The value that will be change rate limited.
MaxRateMaximum allowed value change speed per second

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.

Example

Below is an example plot of 1 Hz Sine signal (cyan) and the same signal with RampFilter operator with property MaxRate=2.5 applied(orange):

Actual Processing Code of the RampFilter

unsigned int RampFilter<T>::Process()
{
  if (!d->dYdtMax)
    return STATUS_ERROR;

  if (d->reset)
    Init();
  m_output = d->filter.Calculate((T)m_input);
  return STATUS_OK;
}

See also Argument.

Member Function Documentation

RampFilter::RampFilter(const CDPPropertyBase &in)

Constructs a RampFilter with input in.

[virtual] RampFilter::~RampFilter()

Destructs the RampFilter operator

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

Reimplemented from CDPBaseObject::Configure().

[override virtual] void RampFilter::Create(const char *shortName, CDPBaseObject *pParent)

Reimplemented from CDPBaseObject::Create().

[override virtual] void RampFilter::Init()

Reimplemented from CDPOperatorBase::Init().

Will initialize/reset the filter. Is called when Reset is performed, and also if parentFs has changed.

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

Reimplemented from CDPOperatorBase::Process().

Does actual Ramp Filter output calculation.

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