ESPHome  2022.6.2
Public Types | Public Member Functions | Protected Attributes
esphome::globals::RestoringGlobalsComponent< T > Class Template Reference

#include <globals_component.h>

Inheritance diagram for esphome::globals::RestoringGlobalsComponent< T >:
esphome::Component

Public Types

using value_type = T
 

Public Member Functions

 RestoringGlobalsComponent ()=default
 
 RestoringGlobalsComponent (T initial_value)
 
 RestoringGlobalsComponent (std::array< typename std::remove_extent< T >::type, std::extent< T >::value > initial_value)
 
T & value ()
 
void setup () override
 
float get_setup_priority () const override
 
void loop () override
 
void set_name_hash (uint32_t name_hash)
 
- Public Member Functions inherited from esphome::Component
virtual void dump_config ()
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Attributes

value_ {}
 
prev_value_ {}
 
uint32_t name_hash_ {}
 
ESPPreferenceObject rtc_
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ = nullptr
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Detailed Description

template<typename T>
class esphome::globals::RestoringGlobalsComponent< T >

Definition at line 27 of file globals_component.h.

Member Typedef Documentation

◆ value_type

template<typename T>
using esphome::globals::RestoringGlobalsComponent< T >::value_type = T

Definition at line 29 of file globals_component.h.

Constructor & Destructor Documentation

◆ RestoringGlobalsComponent() [1/3]

template<typename T>
esphome::globals::RestoringGlobalsComponent< T >::RestoringGlobalsComponent ( )
explicitdefault

◆ RestoringGlobalsComponent() [2/3]

template<typename T>
esphome::globals::RestoringGlobalsComponent< T >::RestoringGlobalsComponent ( initial_value)
inlineexplicit

Definition at line 31 of file globals_component.h.

◆ RestoringGlobalsComponent() [3/3]

template<typename T>
esphome::globals::RestoringGlobalsComponent< T >::RestoringGlobalsComponent ( std::array< typename std::remove_extent< T >::type, std::extent< T >::value initial_value)
inlineexplicit

Definition at line 32 of file globals_component.h.

Member Function Documentation

◆ get_setup_priority()

template<typename T>
float esphome::globals::RestoringGlobalsComponent< T >::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 45 of file globals_component.h.

◆ loop()

template<typename T>
void esphome::globals::RestoringGlobalsComponent< T >::loop ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file globals_component.h.

◆ set_name_hash()

template<typename T>
void esphome::globals::RestoringGlobalsComponent< T >::set_name_hash ( uint32_t  name_hash)
inline

Definition at line 55 of file globals_component.h.

◆ setup()

template<typename T>
void esphome::globals::RestoringGlobalsComponent< T >::setup ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 39 of file globals_component.h.

◆ value()

template<typename T>
T& esphome::globals::RestoringGlobalsComponent< T >::value ( )
inline

Definition at line 37 of file globals_component.h.

Field Documentation

◆ name_hash_

template<typename T>
uint32_t esphome::globals::RestoringGlobalsComponent< T >::name_hash_ {}
protected

Definition at line 60 of file globals_component.h.

◆ prev_value_

template<typename T>
T esphome::globals::RestoringGlobalsComponent< T >::prev_value_ {}
protected

Definition at line 59 of file globals_component.h.

◆ rtc_

template<typename T>
ESPPreferenceObject esphome::globals::RestoringGlobalsComponent< T >::rtc_
protected

Definition at line 61 of file globals_component.h.

◆ value_

template<typename T>
T esphome::globals::RestoringGlobalsComponent< T >::value_ {}
protected

Definition at line 58 of file globals_component.h.


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