ESPHome  1.15.2
Public Member Functions | Protected Attributes
esphome::WhileAction< Ts > Class Template Reference

#include <base_automation.h>

Inheritance diagram for esphome::WhileAction< Ts >:
esphome::Action< Ts... >

Public Member Functions

 WhileAction (Condition< Ts... > *condition)
 
void add_then (const std::vector< Action< Ts... > *> &actions)
 
void play_complex (Ts... x) override
 
void play (Ts... x) override
 
void stop () override
 
- Public Member Functions inherited from esphome::Action< Ts... >
virtual void stop_complex ()
 
virtual bool is_running ()
 Check if this or any of the following actions are currently running. More...
 
int num_running_total ()
 The total number of actions that are currently running in this plus any of the following actions in the chain. More...
 

Protected Attributes

Condition< Ts... > * condition_
 
ActionList< Ts... > then_
 
std::tuple< Ts... > var_ {}
 
- Protected Attributes inherited from esphome::Action< Ts... >
friend ActionList< Ts... >
 
Action< Ts... > * next_
 
int num_running_
 The number of instances of this sequence in the list of actions that is currently being executed. More...
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Action< Ts... >
void play_next_ (Ts... x)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple)
 
void stop_next_ ()
 
bool is_running_next_ ()
 

Detailed Description

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

Definition at line 180 of file base_automation.h.

Constructor & Destructor Documentation

◆ WhileAction()

template<typename... Ts>
esphome::WhileAction< Ts >::WhileAction ( Condition< Ts... > *  condition)
inline

Definition at line 182 of file base_automation.h.

Member Function Documentation

◆ add_then()

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

Definition at line 184 of file base_automation.h.

◆ play()

template<typename... Ts>
void esphome::WhileAction< Ts >::play ( Ts...  x)
inlineoverridevirtual

Implements esphome::Action< Ts... >.

Definition at line 216 of file base_automation.h.

◆ play_complex()

template<typename... Ts>
void esphome::WhileAction< Ts >::play_complex ( Ts...  x)
inlineoverridevirtual

Reimplemented from esphome::Action< Ts... >.

Definition at line 199 of file base_automation.h.

◆ stop()

template<typename... Ts>
void esphome::WhileAction< Ts >::stop ( )
inlineoverridevirtual

Reimplemented from esphome::Action< Ts... >.

Definition at line 219 of file base_automation.h.

Field Documentation

◆ condition_

template<typename... Ts>
Condition<Ts...>* esphome::WhileAction< Ts >::condition_
protected

Definition at line 222 of file base_automation.h.

◆ then_

template<typename... Ts>
ActionList<Ts...> esphome::WhileAction< Ts >::then_
protected

Definition at line 223 of file base_automation.h.

◆ var_

template<typename... Ts>
std::tuple<Ts...> esphome::WhileAction< Ts >::var_ {}
protected

Definition at line 224 of file base_automation.h.


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