Template Class RateLimiter

• Defined in File rate_limiter.hpp

Inheritance Relationships

Base Type

• public filters::FilterBase< T >

Class Documentation

template<typename T>
class RateLimiter : public filters::FilterBase<T>

Usage

The RateLimiter class is meant to be instantiated as a filter in a controller but can also be used elsewhere. For manual instantiation, you should first call configure() (in non-realtime) and then call update() at every update step.

Public Functions

virtual bool configure() override

Configure the RateLimiter (access and process params).

virtual bool update(const T &data_in, T &data_out) override

Applies one step of the rate limiter.

Parameters:

• data_in – input to the limiter

• data_out – limited output

Returns:

false if filter is not configured, true otherwise