ESPHome 2025.7.3
Loading...
Searching...
No Matches
esphome::Scheduler::SchedulerItem Struct Reference

#include <scheduler.h>

Public Types

enum  Type : uint8_t { TIMEOUT , INTERVAL }
 

Public Member Functions

 SchedulerItem ()
 
 ~SchedulerItem ()
 
 SchedulerItem (const SchedulerItem &)=delete
 
SchedulerItemoperator= (const SchedulerItem &)=delete
 
 SchedulerItem (SchedulerItem &&)=delete
 
SchedulerItemoperator= (SchedulerItem &&)=delete
 
const char * get_name () const
 
void set_name (const char *name, bool make_copy=false)
 
const char * get_type_str () const
 
const char * get_source () const
 

Static Public Member Functions

static bool cmp (const std::unique_ptr< SchedulerItem > &a, const std::unique_ptr< SchedulerItem > &b)
 

Data Fields

Componentcomponent
 
uint32_t interval
 
uint64_t next_execution_
 
union { 
 
   const char *   static_name 
 
   char *   dynamic_name 
 
name_ 
 
std::function< void()> callback
 
enum esphome::Scheduler::SchedulerItem::Type type
 
bool remove: 1
 
bool name_is_dynamic: 1
 

Detailed Description

Definition at line 62 of file scheduler.h.

Member Enumeration Documentation

◆ Type

Enumerator
TIMEOUT 
INTERVAL 

Definition at line 80 of file scheduler.h.

Constructor & Destructor Documentation

◆ SchedulerItem() [1/3]

esphome::Scheduler::SchedulerItem::SchedulerItem ( )
inline

Definition at line 86 of file scheduler.h.

◆ ~SchedulerItem()

esphome::Scheduler::SchedulerItem::~SchedulerItem ( )
inline

Definition at line 92 of file scheduler.h.

◆ SchedulerItem() [2/3]

esphome::Scheduler::SchedulerItem::SchedulerItem ( const SchedulerItem & )
delete

◆ SchedulerItem() [3/3]

esphome::Scheduler::SchedulerItem::SchedulerItem ( SchedulerItem && )
delete

Member Function Documentation

◆ cmp()

bool HOT esphome::Scheduler::SchedulerItem::cmp ( const std::unique_ptr< SchedulerItem > & a,
const std::unique_ptr< SchedulerItem > & b )
static

Definition at line 504 of file scheduler.cpp.

◆ get_name()

const char * esphome::Scheduler::SchedulerItem::get_name ( ) const
inline

Definition at line 107 of file scheduler.h.

◆ get_source()

const char * esphome::Scheduler::SchedulerItem::get_source ( ) const
inline

Definition at line 134 of file scheduler.h.

◆ get_type_str()

const char * esphome::Scheduler::SchedulerItem::get_type_str ( ) const
inline

Definition at line 133 of file scheduler.h.

◆ operator=() [1/2]

SchedulerItem & esphome::Scheduler::SchedulerItem::operator= ( const SchedulerItem & )
delete

◆ operator=() [2/2]

SchedulerItem & esphome::Scheduler::SchedulerItem::operator= ( SchedulerItem && )
delete

◆ set_name()

void esphome::Scheduler::SchedulerItem::set_name ( const char * name,
bool make_copy = false )
inline

Definition at line 110 of file scheduler.h.

Field Documentation

◆ callback

std::function<void()> esphome::Scheduler::SchedulerItem::callback

Definition at line 77 of file scheduler.h.

◆ component

Component* esphome::Scheduler::SchedulerItem::component

Definition at line 64 of file scheduler.h.

◆ dynamic_name

char* esphome::Scheduler::SchedulerItem::dynamic_name

Definition at line 74 of file scheduler.h.

◆ interval

uint32_t esphome::Scheduler::SchedulerItem::interval

Definition at line 65 of file scheduler.h.

◆ [union]

union { ... } esphome::Scheduler::SchedulerItem::name_

◆ name_is_dynamic

bool esphome::Scheduler::SchedulerItem::name_is_dynamic

Definition at line 82 of file scheduler.h.

◆ next_execution_

uint64_t esphome::Scheduler::SchedulerItem::next_execution_

Definition at line 69 of file scheduler.h.

◆ remove

bool esphome::Scheduler::SchedulerItem::remove

Definition at line 81 of file scheduler.h.

◆ static_name

const char* esphome::Scheduler::SchedulerItem::static_name

Definition at line 73 of file scheduler.h.

◆ type

enum esphome::Scheduler::SchedulerItem::Type esphome::Scheduler::SchedulerItem::type

The documentation for this struct was generated from the following files: