modm API documentation
modm::Resumable< Functions > Class Template Reference

#include <modm/processing/resumable/resumable.hpp>

Public Member Functions

void stopAllResumables ()
 Force all resumable functions to stop running.
 
bool stopResumable (uint8_t id)
 Force the specified resumable function to stop running.
 
bool isResumableRunning (uint8_t id) const
 
bool areAnyResumablesRunning () const
 
bool areAnyResumablesRunning (std::initializer_list< uint8_t > ids) const
 
bool areAllResumablesRunning (std::initializer_list< uint8_t > ids) const
 
bool joinResumables (std::initializer_list< uint8_t > ids) const
 

Detailed Description

template<uint8_t Functions = 1>
class modm::Resumable< Functions >

Author
Niklas Hauser
Template Parameters
Functionsthe number of resumable functions that are available in this class. Must be non-zero!

Member Function Documentation

template<uint8_t Functions = 1>
bool modm::Resumable< Functions >::areAllResumablesRunning ( std::initializer_list< uint8_t >  ids) const
inline
Returns
true if all of the specified resumable function are running, else false
template<uint8_t Functions = 1>
bool modm::Resumable< Functions >::areAnyResumablesRunning ( ) const
inline
Returns
true if any resumable function of this class is running, else false
template<uint8_t Functions = 1>
bool modm::Resumable< Functions >::areAnyResumablesRunning ( std::initializer_list< uint8_t >  ids) const
inline
Returns
true if any of the specified resumable function are running, else false
template<uint8_t Functions = 1>
bool modm::Resumable< Functions >::isResumableRunning ( uint8_t  id) const
inline
Returns
true if the specified resumable function is running, else false
template<uint8_t Functions = 1>
bool modm::Resumable< Functions >::joinResumables ( std::initializer_list< uint8_t >  ids) const
inline
Returns
true if none of the specified resumable function are running, else false

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