Stefan Scholz / ETL
Embed: (wiki syntax)

« Back to documentation index

callback_timer< MAX_TIMERS_ > Class Template Reference

callback_timer< MAX_TIMERS_ > Class Template Reference

The callback timer. More...

#include <callback_timer.h>

Inherits etl::icallback_timer.

Public Member Functions

 callback_timer ()
 Constructor.
etl::timer::id::type register_timer (void(*p_callback_)(), uint32_t period_, bool repeating_)
 Register a timer.
etl::timer::id::type register_timer (etl::ifunction< void > &callback_, uint32_t period_, bool repeating_)
 Register a timer.
bool unregister_timer (etl::timer::id::type id_)
 Unregister a timer.
void enable (bool state_)
 Enable/disable the timer.
bool is_running () const
 Get the enable/disable state.
void clear ()
 Clears the timer of data.
bool start (etl::timer::id::type id_, bool immediate_=false)
 Starts a timer.
bool stop (etl::timer::id::type id_)
 Stops a timer.
bool set_period (etl::timer::id::type id_, uint32_t period_)
 Sets a timer's period.
bool set_mode (etl::timer::id::type id_, bool repeating_)
 Sets a timer's mode.

Detailed Description

template<const uint_least8_t MAX_TIMERS_>
class etl::callback_timer< MAX_TIMERS_ >

The callback timer.

Definition at line 671 of file callback_timer.h.


Constructor & Destructor Documentation

Constructor.

Definition at line 680 of file callback_timer.h.


Member Function Documentation

void clear (  ) [inherited]

Clears the timer of data.

Definition at line 444 of file callback_timer.h.

void enable ( bool  state_ ) [inherited]

Enable/disable the timer.

Definition at line 428 of file callback_timer.h.

bool is_running (  ) const [inherited]

Get the enable/disable state.

Definition at line 436 of file callback_timer.h.

etl::timer::id::type register_timer ( void(*)()  p_callback_,
uint32_t  period_,
bool  repeating_ 
) [inherited]

Register a timer.

Definition at line 323 of file callback_timer.h.

etl::timer::id::type register_timer ( etl::ifunction< void > &  callback_,
uint32_t  period_,
bool  repeating_ 
) [inherited]

Register a timer.

Definition at line 359 of file callback_timer.h.

bool set_mode ( etl::timer::id::type  id_,
bool  repeating_ 
) [inherited]

Sets a timer's mode.

Definition at line 608 of file callback_timer.h.

bool set_period ( etl::timer::id::type  id_,
uint32_t  period_ 
) [inherited]

Sets a timer's period.

Definition at line 594 of file callback_timer.h.

bool start ( etl::timer::id::type  id_,
bool  immediate_ = false 
) [inherited]

Starts a timer.

Definition at line 526 of file callback_timer.h.

bool stop ( etl::timer::id::type  id_ ) [inherited]

Stops a timer.

Definition at line 564 of file callback_timer.h.

bool unregister_timer ( etl::timer::id::type  id_ ) [inherited]

Unregister a timer.

Definition at line 395 of file callback_timer.h.