• 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

  • Why CDP
    • Software developers
    • Automation engineers
    • Managers
  • Product
    • Design UI
    • Develop
    • Analyze and test
    • Deploy
    • Framework and toolbox
    • Compatibility
  • Services
  • Use cases
  • Pricing
  • Try CDP

CDP Studio Documentation

  • Framework - CDP Core
  • RateLimitedFilter
  • 4.11.3

RateLimitedFilter Class

The RateLimitedFilter class is a rate limited output nonlinear filter. More...

Header: #include <Filter/Filter.h>
Inherits: CDPBaseObject
  • List of all members, including inherited members

Public Functions

RateLimitedFilter()
double Calculate(double x)
double GetYdt()
void Init(double ydtMax, double period)
void SetValue(double newValue)
void SetdYdt(double ydtMax)
double Value()

Reimplemented Public Functions

virtual void Create(const char *shortName, CDPBaseObject *pParent)
virtual std::string GetNodeTypeName() const override
  • 42 public functions inherited from CDPBaseObject
  • 26 public functions inherited from CDP::StudioAPI::CDPNode
  • 22 public functions inherited from CDP::StudioAPI::ICDPNode

Additional Inherited Members

  • 1 static public member inherited from CDPBaseObject
  • 1 protected function inherited from CDP::StudioAPI::CDPNode
  • 9 protected variables inherited from CDPBaseObject

Detailed Description

The RateLimitedFilter class is a rate limited output nonlinear filter.

See also IIRFilter and Integrator.

Member Function Documentation

RateLimitedFilter::RateLimitedFilter()

Set default values to prevent errors if Init() has not been called.

double RateLimitedFilter::Calculate(double x)

Calculates new output value based on x. This function must be called exactly once every process period for the filter to behave correctly. Call periodically.

Note: To read the output more than once each period, use Value() method to prevent a new output from being calculated again.

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

Reimplemented from CDPBaseObject::Create().

Creates the fiter with shortName and pParent as parent object.

[override virtual] std::string RateLimitedFilter::GetNodeTypeName() const

Reimplemented from ICDPNode::GetNodeTypeName().

Returns "RateLimitedFilter"

double RateLimitedFilter::GetYdt()

Returns maximum output change per second

void RateLimitedFilter::Init(double ydtMax, double period)

Initializes the filter. Sets ydtMax to maximum output rate change per second, and set the period to the sample interval (1/Hz) This function can also be used to reset the filter memory and output.

void RateLimitedFilter::SetValue(double newValue)

Sets the output directly from newValue

void RateLimitedFilter::SetdYdt(double ydtMax)

Sets maximum output change per second from ydtMax

double RateLimitedFilter::Value()

Returns current output value.

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

Follow CDP

  • LinkedIn
  • YouTube
  • GitHub

    © Copyright 2022 CDP Technologies. Privacy and cookie policy.

    Return to top