control_filters::RateLimiter< T > Class Template Reference

#include <rate_limiter.hpp>

Inheritance diagram for control_filters::RateLimiter< T >:

Collaboration diagram for control_filters::RateLimiter< T >:

Public Member Functions
bool	configure () override
	Configure the RateLimiter (access and process params).
bool	update (const T &data_in, T &data_out) override
	Applies one step of the rate limiter.

Detailed Description

template<typename T>
class control_filters::RateLimiter< 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.

Member Function Documentation

update()

template<typename T >

bool control_filters::RateLimiter< T >::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

---

The documentation for this class was generated from the following file:

• control_toolbox/include/control_filters/rate_limiter.hpp