esphome::ComponentIterator Class Reference

#include <component_iterator.h>

Inheritance diagram for esphome::ComponentIterator:

Public Member Functions
void	begin (bool include_internal=false)
void	advance ()
virtual bool	on_begin ()
virtual bool	on_binary_sensor (binary_sensor::BinarySensor *binary_sensor)=0
virtual bool	on_cover (cover::Cover *cover)=0
virtual bool	on_fan (fan::Fan *fan)=0
virtual bool	on_light (light::LightState *light)=0
virtual bool	on_sensor (sensor::Sensor *sensor)=0
virtual bool	on_switch (switch_::Switch *a_switch)=0
virtual bool	on_button (button::Button *button)=0
virtual bool	on_text_sensor (text_sensor::TextSensor *text_sensor)=0
virtual bool	on_service (api::UserServiceDescriptor *service)
virtual bool	on_camera (camera::Camera *camera)
virtual bool	on_climate (climate::Climate *climate)=0
virtual bool	on_number (number::Number *number)=0
virtual bool	on_date (datetime::DateEntity *date)=0
virtual bool	on_time (datetime::TimeEntity *time)=0
virtual bool	on_datetime (datetime::DateTimeEntity *datetime)=0
virtual bool	on_text (text::Text *text)=0
virtual bool	on_select (select::Select *select)=0
virtual bool	on_lock (lock::Lock *a_lock)=0
virtual bool	on_valve (valve::Valve *valve)=0
virtual bool	on_media_player (media_player::MediaPlayer *media_player)
virtual bool	on_alarm_control_panel (alarm_control_panel::AlarmControlPanel *a_alarm_control_panel)=0
virtual bool	on_event (event::Event *event)=0
virtual bool	on_update (update::UpdateEntity *update)=0
virtual bool	on_end ()

Protected Types
enum class	IteratorState : uint8_t {   NONE = 0 , BEGIN , BINARY_SENSOR , COVER ,   FAN , LIGHT , SENSOR , SWITCH ,   BUTTON , TEXT_SENSOR , SERVICE , CAMERA ,   CLIMATE , NUMBER , DATETIME_DATE , DATETIME_TIME ,   DATETIME_DATETIME , TEXT , SELECT , LOCK ,   VALVE , MEDIA_PLAYER , ALARM_CONTROL_PANEL , EVENT ,   UPDATE , MAX }

Protected Member Functions
template<typename Container >
void	process_platform_item_ (const Container &items, bool(ComponentIterator::*on_item)(typename Container::value_type))
void	advance_platform_ ()

Protected Attributes
uint16_t	at_ {0}
IteratorState	state_ {IteratorState::NONE}
bool	include_internal_ {false}

Detailed Description

Definition at line 19 of file component_iterator.h.

Member Enumeration Documentation

IteratorState

enum class esphome::ComponentIterator::IteratorState : uint8_t

strongprotected

Enumerator
NONE
BEGIN
BINARY_SENSOR
COVER
FAN
LIGHT
SENSOR
SWITCH
BUTTON
TEXT_SENSOR
SERVICE
CAMERA
CLIMATE
NUMBER
DATETIME_DATE
DATETIME_TIME
DATETIME_DATETIME
TEXT
SELECT
LOCK
VALVE
MEDIA_PLAYER
ALARM_CONTROL_PANEL
EVENT
UPDATE
MAX

Definition at line 98 of file component_iterator.h.

Member Function Documentation

advance()

void esphome::ComponentIterator::advance

(

)

Definition at line 25 of file component_iterator.cpp.

advance_platform_()

void esphome::ComponentIterator::advance_platform_ ( )

protected

Definition at line 20 of file component_iterator.cpp.

begin()

void esphome::ComponentIterator::begin

(

bool

include_internal = false

)

Definition at line 14 of file component_iterator.cpp.

on_alarm_control_panel()

virtual bool esphome::ComponentIterator::on_alarm_control_panel ( alarm_control_panel::AlarmControlPanel * a_alarm_control_panel )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_begin()

bool esphome::ComponentIterator::on_begin ( )

virtual

Definition at line 187 of file component_iterator.cpp.

on_binary_sensor()

virtual bool esphome::ComponentIterator::on_binary_sensor ( binary_sensor::BinarySensor * binary_sensor )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_button()

virtual bool esphome::ComponentIterator::on_button ( button::Button * button )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_camera()

bool esphome::ComponentIterator::on_camera ( camera::Camera * camera )

virtual

Reimplemented in esphome::api::ListEntitiesIterator.

Definition at line 192 of file component_iterator.cpp.

on_climate()

virtual bool esphome::ComponentIterator::on_climate ( climate::Climate * climate )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_cover()

virtual bool esphome::ComponentIterator::on_cover ( cover::Cover * cover )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_date()

virtual bool esphome::ComponentIterator::on_date ( datetime::DateEntity * date )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_datetime()

virtual bool esphome::ComponentIterator::on_datetime ( datetime::DateTimeEntity * datetime )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_end()

bool esphome::ComponentIterator::on_end ( )

virtual

Reimplemented in esphome::api::ListEntitiesIterator.

Definition at line 186 of file component_iterator.cpp.

on_event()

virtual bool esphome::ComponentIterator::on_event ( event::Event * event )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_fan()

virtual bool esphome::ComponentIterator::on_fan ( fan::Fan * fan )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_light()

virtual bool esphome::ComponentIterator::on_light ( light::LightState * light )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_lock()

virtual bool esphome::ComponentIterator::on_lock ( lock::Lock * a_lock )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_media_player()

bool esphome::ComponentIterator::on_media_player ( media_player::MediaPlayer * media_player )

virtual

Reimplemented in esphome::api::InitialStateIterator, and esphome::api::ListEntitiesIterator.

Definition at line 195 of file component_iterator.cpp.

on_number()

virtual bool esphome::ComponentIterator::on_number ( number::Number * number )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_select()

virtual bool esphome::ComponentIterator::on_select ( select::Select * select )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_sensor()

virtual bool esphome::ComponentIterator::on_sensor ( sensor::Sensor * sensor )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_service()

bool esphome::ComponentIterator::on_service ( api::UserServiceDescriptor * service )

virtual

Reimplemented in esphome::api::ListEntitiesIterator.

Definition at line 189 of file component_iterator.cpp.

on_switch()

virtual bool esphome::ComponentIterator::on_switch ( switch_::Switch * a_switch )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_text()

virtual bool esphome::ComponentIterator::on_text ( text::Text * text )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_text_sensor()

virtual bool esphome::ComponentIterator::on_text_sensor ( text_sensor::TextSensor * text_sensor )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_time()

virtual bool esphome::ComponentIterator::on_time ( datetime::TimeEntity * time )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_update()

virtual bool esphome::ComponentIterator::on_update ( update::UpdateEntity * update )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

on_valve()

virtual bool esphome::ComponentIterator::on_valve ( valve::Valve * valve )

pure virtual

Implemented in esphome::api::InitialStateIterator, esphome::api::ListEntitiesIterator, and esphome::web_server::ListEntitiesIterator.

process_platform_item_()

template<typename Container >

void esphome::ComponentIterator::process_platform_item_ ( const Container & items, bool(ComponentIterator::* on_item )(typename Container::value_type) )

inlineprotected

Definition at line 177 of file component_iterator.h.

Field Documentation

at_

uint16_t esphome::ComponentIterator::at_ {0}

protected

Definition at line 172 of file component_iterator.h.

include_internal_

bool esphome::ComponentIterator::include_internal_ {false}

protected

Definition at line 174 of file component_iterator.h.

state_

IteratorState esphome::ComponentIterator::state_ {IteratorState::NONE}

protected

Definition at line 173 of file component_iterator.h.

---

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

• esphome/core/component_iterator.h
• esphome/core/component_iterator.cpp