ESPHome  2024.10.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::ActionList< Ts > Class Template Reference

#include <automation.h>

Public Member Functions

void add_action (Action< Ts... > *action)
 
void add_actions (const std::vector< Action< Ts... > *> &actions)
 
void play (Ts... x)
 
void play_tuple (const std::tuple< Ts... > &tuple)
 
void stop ()
 
bool empty () const
 
bool is_running ()
 Check if any action in this action list is currently running. More...
 
int num_running ()
 Return the number of actions in this action list that are currently running. More...
 

Protected Member Functions

template<int... S>
void play_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)
 

Protected Attributes

Action< Ts... > * actions_begin_ {nullptr}
 
Action< Ts... > * actions_end_ {nullptr}
 

Detailed Description

template<typename... Ts>
class esphome::ActionList< Ts >

Definition at line 119 of file automation.h.

Member Function Documentation

◆ add_action()

template<typename... Ts>
void esphome::ActionList< Ts >::add_action ( Action< Ts... > *  action)
inline

Definition at line 188 of file automation.h.

◆ add_actions()

template<typename... Ts>
void esphome::ActionList< Ts >::add_actions ( const std::vector< Action< Ts... > *> &  actions)
inline

Definition at line 196 of file automation.h.

◆ empty()

template<typename... Ts>
bool esphome::ActionList< Ts >::empty ( ) const
inline

Definition at line 210 of file automation.h.

◆ is_running()

template<typename... Ts>
bool esphome::ActionList< Ts >::is_running ( )
inline

Check if any action in this action list is currently running.

Definition at line 213 of file automation.h.

◆ num_running()

template<typename... Ts>
int esphome::ActionList< Ts >::num_running ( )
inline

Return the number of actions in this action list that are currently running.

Definition at line 219 of file automation.h.

◆ play()

template<typename... Ts>
void esphome::ActionList< Ts >::play ( Ts...  x)
inline

Definition at line 201 of file automation.h.

◆ play_tuple()

template<typename... Ts>
void esphome::ActionList< Ts >::play_tuple ( const std::tuple< Ts... > &  tuple)
inline

Definition at line 205 of file automation.h.

◆ play_tuple_()

template<typename... Ts>
template<int... S>
void esphome::ActionList< Ts >::play_tuple_ ( const std::tuple< Ts... > &  tuple,
seq< S... >   
)
inlineprotected

Definition at line 226 of file automation.h.

◆ stop()

template<typename... Ts>
void esphome::ActionList< Ts >::stop ( )
inline

Definition at line 206 of file automation.h.

Field Documentation

◆ actions_begin_

template<typename... Ts>
Action<Ts...>* esphome::ActionList< Ts >::actions_begin_ {nullptr}
protected

Definition at line 230 of file automation.h.

◆ actions_end_

template<typename... Ts>
Action<Ts...>* esphome::ActionList< Ts >::actions_end_ {nullptr}
protected

Definition at line 231 of file automation.h.


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