rav::Throttle< T > Class Template Reference

A class that throttles a value to a given interval. More...

#include <throttle.hpp>

Public Member Functions
	Throttle ()=default
	Throttle (const std::chrono::milliseconds interval)
	Constructs the throttle with the given interval.
void	set_interval (const std::chrono::milliseconds interval)
std::optional< T >	update (T value)
	Updates the value and if the interval has passed since the last update returns the new value.
std::optional< T >	get ()
std::optional< T >	get_throttled ()
void	clear ()
	Clears the stored value.

Detailed Description

template<class T>
class rav::Throttle< T >

A class that throttles a value to a given interval.

Template Parameters

T	The type of the value to throttle.

Definition at line 36 of file throttle.hpp.

Constructor & Destructor Documentation

Throttle() [1/2]

template<class T>

rav::Throttle< T >::Throttle ( )

default

Throttle() [2/2]

template<class T>

rav::Throttle< T >::Throttle ( const std::chrono::milliseconds interval )

inlineexplicit

Constructs the throttle with the given interval.

Parameters

interval

The interval to throttle the value to.

Definition at line 44 of file throttle.hpp.

Member Function Documentation

clear()

template<class T>

void rav::Throttle< T >::clear ( )

inline

Clears the stored value.

Definition at line 89 of file throttle.hpp.

get()

template<class T>

std::optional< T > rav::Throttle< T >::get ( )

inline

Returns

The value, which might be empty if no value was set before.

Definition at line 67 of file throttle.hpp.

get_throttled()

template<class T>

std::optional< T > rav::Throttle< T >::get_throttled ( )

inline

Returns

The value if the interval has passed since the last update, otherwise an empty optional. The last set value will be returned, even if the value wasn't changed since the last call to update.

Definition at line 75 of file throttle.hpp.

set_interval()

template<class T>

void rav::Throttle< T >::set_interval ( const std::chrono::milliseconds interval )

inline

Parameters

interval

The interval to throttle the value to.

Definition at line 49 of file throttle.hpp.

update()

template<class T>

std::optional< T > rav::Throttle< T >::update ( T value )

inline

Updates the value and if the interval has passed since the last update returns the new value.

If the value is equal to the current value, nothing will happen and the function will return an empty optional.

Parameters

value

The new value.

Returns

The value if changed and the interval was passed, otherwise an empty optional.

Definition at line 59 of file throttle.hpp.

---

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

• throttle.hpp