ESPHome  2024.10.2
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
esphome::globals::RestoringGlobalStringComponent< T, SZ > Class Template Reference

#include <globals_component.h>

Inheritance diagram for esphome::globals::RestoringGlobalStringComponent< T, SZ >:
esphome::Component

Public Types

using value_type = T
 

Public Member Functions

 RestoringGlobalStringComponent ()=default
 
 RestoringGlobalStringComponent (T initial_value)
 
 RestoringGlobalStringComponent (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 on_shutdown () 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_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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 Member Functions

void store_value_ ()
 
- 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(uint8_t)> &&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(uint8_t)> &&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...
 

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}
 

Detailed Description

template<typename T, uint8_t SZ>
class esphome::globals::RestoringGlobalStringComponent< T, SZ >

Definition at line 69 of file globals_component.h.

Member Typedef Documentation

◆ value_type

template<typename T, uint8_t SZ>
using esphome::globals::RestoringGlobalStringComponent< T, SZ >::value_type = T

Definition at line 71 of file globals_component.h.

Constructor & Destructor Documentation

◆ RestoringGlobalStringComponent() [1/3]

template<typename T, uint8_t SZ>
esphome::globals::RestoringGlobalStringComponent< T, SZ >::RestoringGlobalStringComponent ( )
explicitdefault

◆ RestoringGlobalStringComponent() [2/3]

template<typename T, uint8_t SZ>
esphome::globals::RestoringGlobalStringComponent< T, SZ >::RestoringGlobalStringComponent ( initial_value)
inlineexplicit

Definition at line 73 of file globals_component.h.

◆ RestoringGlobalStringComponent() [3/3]

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

Definition at line 74 of file globals_component.h.

Member Function Documentation

◆ get_setup_priority()

template<typename T, uint8_t SZ>
float esphome::globals::RestoringGlobalStringComponent< T, SZ >::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 91 of file globals_component.h.

◆ loop()

template<typename T, uint8_t SZ>
void esphome::globals::RestoringGlobalStringComponent< T, SZ >::loop ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 93 of file globals_component.h.

◆ on_shutdown()

template<typename T, uint8_t SZ>
void esphome::globals::RestoringGlobalStringComponent< T, SZ >::on_shutdown ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 95 of file globals_component.h.

◆ set_name_hash()

template<typename T, uint8_t SZ>
void esphome::globals::RestoringGlobalStringComponent< T, SZ >::set_name_hash ( uint32_t  name_hash)
inline

Definition at line 97 of file globals_component.h.

◆ setup()

template<typename T, uint8_t SZ>
void esphome::globals::RestoringGlobalStringComponent< T, SZ >::setup ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 81 of file globals_component.h.

◆ store_value_()

template<typename T, uint8_t SZ>
void esphome::globals::RestoringGlobalStringComponent< T, SZ >::store_value_ ( )
inlineprotected

Definition at line 100 of file globals_component.h.

◆ value()

template<typename T, uint8_t SZ>
T& esphome::globals::RestoringGlobalStringComponent< T, SZ >::value ( )
inline

Definition at line 79 of file globals_component.h.

Field Documentation

◆ name_hash_

template<typename T, uint8_t SZ>
uint32_t esphome::globals::RestoringGlobalStringComponent< T, SZ >::name_hash_ {}
protected

Definition at line 122 of file globals_component.h.

◆ prev_value_

template<typename T, uint8_t SZ>
T esphome::globals::RestoringGlobalStringComponent< T, SZ >::prev_value_ {}
protected

Definition at line 121 of file globals_component.h.

◆ rtc_

template<typename T, uint8_t SZ>
ESPPreferenceObject esphome::globals::RestoringGlobalStringComponent< T, SZ >::rtc_
protected

Definition at line 123 of file globals_component.h.

◆ value_

template<typename T, uint8_t SZ>
T esphome::globals::RestoringGlobalStringComponent< T, SZ >::value_ {}
protected

Definition at line 120 of file globals_component.h.


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