#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 (esp32_camera::ESP32Camera *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_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_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_end ()

Protected Attributes
enum esphome::ComponentIterator::IteratorState	NONE

size_t	at_ {0}

bool	include_internal_ {false}

Detailed Description

Definition at line 19 of file component_iterator.h.

Member Enumeration Documentation

◆ IteratorState

enum esphome::ComponentIterator::IteratorState

strongprotected

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

Definition at line 84 of file component_iterator.h.

Member Function Documentation

◆ advance()

void esphome::ComponentIterator::advance ( )

Definition at line 17 of file component_iterator.cpp.

◆ begin()

void esphome::ComponentIterator::begin ( bool include_internal = false )

Definition at line 12 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::ListEntitiesIterator, esphome::api::InitialStateIterator, and esphome::web_server::ListEntitiesIterator.

◆ on_begin()

bool esphome::ComponentIterator::on_begin ( )

virtual

Definition at line 325 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 ( esp32_camera::ESP32Camera * camera )

virtual

Reimplemented in esphome::api::ListEntitiesIterator.

Definition at line 330 of file component_iterator.cpp.

◆ on_climate()

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

pure virtual

Implemented in esphome::api::ListEntitiesIterator, esphome::api::InitialStateIterator, 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::ListEntitiesIterator, esphome::api::InitialStateIterator, and esphome::web_server::ListEntitiesIterator.

◆ on_end()

bool esphome::ComponentIterator::on_end ( )

virtual

Reimplemented in esphome::api::ListEntitiesIterator.

Definition at line 324 of file component_iterator.cpp.

◆ 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::ListEntitiesIterator, esphome::api::InitialStateIterator, and esphome::web_server::ListEntitiesIterator.

◆ on_media_player()

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

virtual

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

Definition at line 333 of file component_iterator.cpp.

◆ on_number()

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

pure virtual

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

◆ on_select()

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

pure virtual

Implemented in esphome::api::ListEntitiesIterator, esphome::api::InitialStateIterator, 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 327 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::ListEntitiesIterator, esphome::api::InitialStateIterator, 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::ListEntitiesIterator, esphome::api::InitialStateIterator, and esphome::web_server::ListEntitiesIterator.

Field Documentation

◆ at_

size_t esphome::ComponentIterator::at_ {0}

protected

Definition at line 146 of file component_iterator.h.

◆ include_internal_

bool esphome::ComponentIterator::include_internal_ {false}

protected

Definition at line 147 of file component_iterator.h.

◆ NONE

enum esphome::ComponentIterator::IteratorState esphome::ComponentIterator::NONE

protected

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

/opt/build/esphome/esphome/core/component_iterator.h
/opt/build/esphome/esphome/core/component_iterator.cpp

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

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ IteratorState

Member Function Documentation

◆ advance()

◆ begin()

◆ on_alarm_control_panel()

◆ on_begin()

◆ on_binary_sensor()

◆ on_button()

◆ on_camera()

◆ on_climate()

◆ on_cover()

◆ on_date()

◆ on_end()

◆ on_fan()

◆ on_light()

◆ on_lock()

◆ on_media_player()

◆ on_number()

◆ on_select()

◆ on_sensor()

◆ on_service()

◆ on_switch()

◆ on_text()

◆ on_text_sensor()

◆ on_time()

Field Documentation

◆ at_

◆ include_internal_

◆ NONE