ESPHome 2026.1.4
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Attributes
esphome::TemplatableValue< T, X > Class Template Reference

#include <automation.h>

Public Member Functions

 TemplatableValue ()
 
 TemplatableValue (const char *str)
 
template<typename F >
requires (!std::invocable<F, X...>)
 TemplatableValue (F value)
 
template<typename F >
requires std::invocable<F, X...> && std::convertible_to<F, T (*)(X...)>
 TemplatableValue (F f)
 
template<typename F >
requires std::invocable<F, X...> &&(!std::convertible_to<F, T (*)(X...)>)
 TemplatableValue (F f)
 
 TemplatableValue (const TemplatableValue &other)
 
 TemplatableValue (TemplatableValue &&other) noexcept
 
TemplatableValue & operator= (const TemplatableValue &other)
 
TemplatableValue & operator= (TemplatableValue &&other) noexcept
 
 ~TemplatableValue ()
 
bool has_value () const
 
T value (X... x) const
 
optional< T > optional_value (X... x)
 
T value_or (X... x, T default_value)
 
bool is_static_string () const
 Check if this holds a static string (const char* stored without allocation)
 
const char * get_static_string () const
 Get the static string pointer (only valid if is_static_string() returns true)
 

Protected Types

enum  : uint8_t {
  NONE , VALUE , LAMBDA , STATELESS_LAMBDA ,
  STATIC_STRING
}
 
using ValueStorage = std::conditional_t<USE_HEAP_STORAGE, T *, T>
 

Protected Attributes

enum esphome::TemplatableValue:: { ... }  type_
 
union { 
 
   ValueStorage   value_ 
 
   std::function< T(X...)> *   f_ 
 
   T(*   stateless_f_ )(X...) 
 
   const char *   static_str_ 
 
};  
 

Detailed Description

template<typename T, typename... X>
class esphome::TemplatableValue< T, X >

Definition at line 44 of file automation.h.

Member Typedef Documentation

◆ ValueStorage

template<typename T , typename... X>
using esphome::TemplatableValue< T, X >::ValueStorage = std::conditional_t<USE_HEAP_STORAGE, T *, T>
protected

Definition at line 204 of file automation.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename T , typename... X>
anonymous enum : uint8_t
protected
Enumerator
NONE 
VALUE 
LAMBDA 
STATELESS_LAMBDA 
STATIC_STRING 

Definition at line 194 of file automation.h.

Constructor & Destructor Documentation

◆ TemplatableValue() [1/7]

template<typename T , typename... X>
esphome::TemplatableValue< T, X >::TemplatableValue ( )
inline

Definition at line 50 of file automation.h.

◆ TemplatableValue() [2/7]

template<typename T , typename... X>
esphome::TemplatableValue< T, X >::TemplatableValue ( const char * str)
inline

Definition at line 54 of file automation.h.

◆ TemplatableValue() [3/7]

template<typename T , typename... X>
template<typename F >
requires (!std::invocable<F, X...>)
esphome::TemplatableValue< T, X >::TemplatableValue ( F value)
inline

Definition at line 58 of file automation.h.

◆ TemplatableValue() [4/7]

template<typename T , typename... X>
template<typename F >
requires std::invocable<F, X...> && std::convertible_to<F, T (*)(X...)>
esphome::TemplatableValue< T, X >::TemplatableValue ( F f)
inline

Definition at line 68 of file automation.h.

◆ TemplatableValue() [5/7]

template<typename T , typename... X>
template<typename F >
requires std::invocable<F, X...> &&(!std::convertible_to<F, T (*)(X...)>)
esphome::TemplatableValue< T, X >::TemplatableValue ( F f)
inline

Definition at line 75 of file automation.h.

◆ TemplatableValue() [6/7]

template<typename T , typename... X>
esphome::TemplatableValue< T, X >::TemplatableValue ( const TemplatableValue< T, X > & other)
inline

Definition at line 80 of file automation.h.

◆ TemplatableValue() [7/7]

template<typename T , typename... X>
esphome::TemplatableValue< T, X >::TemplatableValue ( TemplatableValue< T, X > && other)
inlinenoexcept

Definition at line 97 of file automation.h.

◆ ~TemplatableValue()

template<typename T , typename... X>
esphome::TemplatableValue< T, X >::~TemplatableValue ( )
inline

Definition at line 133 of file automation.h.

Member Function Documentation

◆ get_static_string()

template<typename T , typename... X>
const char * esphome::TemplatableValue< T, X >::get_static_string ( ) const
inline

Get the static string pointer (only valid if is_static_string() returns true)

Definition at line 191 of file automation.h.

◆ has_value()

template<typename T , typename... X>
bool esphome::TemplatableValue< T, X >::has_value ( ) const
inline

Definition at line 146 of file automation.h.

◆ is_static_string()

template<typename T , typename... X>
bool esphome::TemplatableValue< T, X >::is_static_string ( ) const
inline

Check if this holds a static string (const char* stored without allocation)

Definition at line 188 of file automation.h.

◆ operator=() [1/2]

template<typename T , typename... X>
TemplatableValue & esphome::TemplatableValue< T, X >::operator= ( const TemplatableValue< T, X > & other)
inline

Definition at line 117 of file automation.h.

◆ operator=() [2/2]

template<typename T , typename... X>
TemplatableValue & esphome::TemplatableValue< T, X >::operator= ( TemplatableValue< T, X > && other)
inlinenoexcept

Definition at line 125 of file automation.h.

◆ optional_value()

template<typename T , typename... X>
optional< T > esphome::TemplatableValue< T, X >::optional_value ( X... x)
inline

Definition at line 173 of file automation.h.

◆ value()

template<typename T , typename... X>
T esphome::TemplatableValue< T, X >::value ( X... x) const
inline

Definition at line 148 of file automation.h.

◆ value_or()

template<typename T , typename... X>
T esphome::TemplatableValue< T, X >::value_or ( X... x,
T default_value )
inline

Definition at line 180 of file automation.h.

Field Documentation

◆ [union]

union { ... } esphome::TemplatableValue< T, X >

◆ f_

template<typename T , typename... X>
std::function<T(X...)>* esphome::TemplatableValue< T, X >::f_

Definition at line 207 of file automation.h.

◆ stateless_f_

template<typename T , typename... X>
T(* esphome::TemplatableValue< T, X >::stateless_f_) (X...)

Definition at line 208 of file automation.h.

◆ static_str_

template<typename T , typename... X>
const char* esphome::TemplatableValue< T, X >::static_str_

Definition at line 209 of file automation.h.

◆ []

enum { ... } esphome::TemplatableValue< T, X >::type_

◆ value_

template<typename T , typename... X>
ValueStorage esphome::TemplatableValue< T, X >::value_

Definition at line 206 of file automation.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0