Rate limiter class.

Dependents:   BLDC_mainProgram L298N-Breakout-Test HBridgeDCMotor STMF302R8_MotorDrive ... more

Embed: (wiki syntax)

« Back to documentation index

RateLimiter Class Reference

RateLimiter Class Reference

A rate limiter class. More...

#include <RateLimiter.h>

Public Member Functions

 RateLimiter ()
 Default constructor.
 RateLimiter (float R, float F, float initialCondition, float sampleTime)
 Constructor receives rising (R) and falling (F) rate limits, initial condition of the output and sample time in seconds.
void setLimits (float R, float F)
 Setting the rate limits R and F.
float out (float input)
 Calculating the output of the rate limiter for the given input.
void reset ()
 Reset the output of the rate limiter to zero.

Detailed Description

A rate limiter class.

Author(s): TVZ Mechatronics Team

Definition at line 11 of file RateLimiter.h.


Constructor & Destructor Documentation

RateLimiter (  )

Default constructor.

Definition at line 3 of file RateLimiter.cpp.

RateLimiter ( float  R,
float  F,
float  initialCondition,
float  sampleTime 
)

Constructor receives rising (R) and falling (F) rate limits, initial condition of the output and sample time in seconds.

Definition at line 7 of file RateLimiter.cpp.


Member Function Documentation

float out ( float  input )

Calculating the output of the rate limiter for the given input.

Definition at line 42 of file RateLimiter.cpp.

void reset (  )

Reset the output of the rate limiter to zero.

Definition at line 11 of file RateLimiter.cpp.

void setLimits ( float  R,
float  F 
)

Setting the rate limits R and F.

Definition at line 15 of file RateLimiter.cpp.