RampFilter Class
(Automation::RampFilter)Ramp filter limits the rate of change on input value by given MaxRate to produce output. More...
Header: | #include <RampFilter.h> |
Inherits: | CDPOperator<T> |
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 | FillNodeChildren(CDP::StudioAPI::NodeStream &stream) const override |
virtual void | Init() override |
virtual unsigned int | Process() override |
- 18 public functions inherited from CDPOperator
- 17 public functions inherited from CDPOperatorBase
- 46 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 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
- 11 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
Property | Description |
---|---|
Reset | Resets RampFilter calculation. When toggled from 0 to 1 RampFilter signal change history is cleared. |
Arguments
Name | Description |
---|---|
Out | The default output. The change rate limited value. |
In | The default input. The value that will be change rate limited. |
MaxRate | Maximum 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::FillNodeChildren(CDP::StudioAPI::NodeStream &stream) const
Reimplemented from CDPNode::FillNodeChildren().
Exposes himself and Arguments to Studio
[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.
Get started with CDP Studio today
Let us help you take your great ideas and turn them into the products your customer will love.