ESPHome  2025.3.3
Public Member Functions | Protected Attributes
esphome::web_server::ListEntitiesIterator Class Reference

#include <list_entities.h>

Inheritance diagram for esphome::web_server::ListEntitiesIterator:
esphome::ComponentIterator

Public Member Functions

 ListEntitiesIterator (const WebServer *ws, DeferredUpdateEventSource *es)
 
 ListEntitiesIterator (const WebServer *ws, esphome::web_server_idf::AsyncEventSource *es)
 
virtual ~ListEntitiesIterator ()
 
bool on_binary_sensor (binary_sensor::BinarySensor *obj) override
 
bool on_cover (cover::Cover *obj) override
 
bool on_fan (fan::Fan *obj) override
 
bool on_light (light::LightState *obj) override
 
bool on_sensor (sensor::Sensor *obj) override
 
bool on_switch (switch_::Switch *obj) override
 
bool on_button (button::Button *obj) override
 
bool on_text_sensor (text_sensor::TextSensor *obj) override
 
bool on_climate (climate::Climate *obj) override
 
bool on_number (number::Number *obj) override
 
bool on_date (datetime::DateEntity *obj) override
 
bool on_time (datetime::TimeEntity *obj) override
 
bool on_datetime (datetime::DateTimeEntity *obj) override
 
bool on_text (text::Text *obj) override
 
bool on_select (select::Select *obj) override
 
bool on_lock (lock::Lock *obj) override
 
bool on_valve (valve::Valve *obj) override
 
bool on_alarm_control_panel (alarm_control_panel::AlarmControlPanel *obj) override
 
bool on_event (event::Event *obj) override
 
bool on_update (update::UpdateEntity *obj) override
 
bool completed ()
 
- Public Member Functions inherited from esphome::ComponentIterator
void begin (bool include_internal=false)
 
void advance ()
 
virtual bool on_begin ()
 
virtual bool on_service (api::UserServiceDescriptor *service)
 
virtual bool on_camera (esp32_camera::ESP32Camera *camera)
 
virtual bool on_media_player (media_player::MediaPlayer *media_player)
 
virtual bool on_end ()
 

Protected Attributes

const WebServerweb_server_
 
DeferredUpdateEventSourceevents_
 
esphome::web_server_idf::AsyncEventSourceevents_
 
- Protected Attributes inherited from esphome::ComponentIterator
enum esphome::ComponentIterator::IteratorState NONE
 
size_t at_ {0}
 
bool include_internal_ {false}
 

Additional Inherited Members

- Protected Types inherited from esphome::ComponentIterator
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::DATETIME_DATETIME, IteratorState::TEXT, IteratorState::SELECT, IteratorState::LOCK,
  IteratorState::VALVE, IteratorState::MEDIA_PLAYER, IteratorState::ALARM_CONTROL_PANEL, IteratorState::EVENT,
  IteratorState::UPDATE, IteratorState::MAX
}
 

Detailed Description

Definition at line 20 of file list_entities.h.

Constructor & Destructor Documentation

◆ ListEntitiesIterator() [1/2]

esphome::web_server::ListEntitiesIterator::ListEntitiesIterator ( const WebServer ws,
DeferredUpdateEventSource es 
)

Definition at line 13 of file list_entities.cpp.

◆ ListEntitiesIterator() [2/2]

esphome::web_server::ListEntitiesIterator::ListEntitiesIterator ( const WebServer ws,
esphome::web_server_idf::AsyncEventSource es 
)

◆ ~ListEntitiesIterator()

esphome::web_server::ListEntitiesIterator::~ListEntitiesIterator ( )
virtual

Definition at line 19 of file list_entities.cpp.

Member Function Documentation

◆ completed()

bool esphome::web_server::ListEntitiesIterator::completed ( )
inline

Definition at line 89 of file list_entities.h.

◆ on_alarm_control_panel()

bool esphome::web_server::ListEntitiesIterator::on_alarm_control_panel ( alarm_control_panel::AlarmControlPanel obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 167 of file list_entities.cpp.

◆ on_binary_sensor()

bool esphome::web_server::ListEntitiesIterator::on_binary_sensor ( binary_sensor::BinarySensor obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 22 of file list_entities.cpp.

◆ on_button()

bool esphome::web_server::ListEntitiesIterator::on_button ( button::Button obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 70 of file list_entities.cpp.

◆ on_climate()

bool esphome::web_server::ListEntitiesIterator::on_climate ( climate::Climate obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 104 of file list_entities.cpp.

◆ on_cover()

bool esphome::web_server::ListEntitiesIterator::on_cover ( cover::Cover obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 30 of file list_entities.cpp.

◆ on_date()

bool esphome::web_server::ListEntitiesIterator::on_date ( datetime::DateEntity obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 122 of file list_entities.cpp.

◆ on_datetime()

bool esphome::web_server::ListEntitiesIterator::on_datetime ( datetime::DateTimeEntity obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 140 of file list_entities.cpp.

◆ on_event()

bool esphome::web_server::ListEntitiesIterator::on_event ( event::Event obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 176 of file list_entities.cpp.

◆ on_fan()

bool esphome::web_server::ListEntitiesIterator::on_fan ( fan::Fan obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 38 of file list_entities.cpp.

◆ on_light()

bool esphome::web_server::ListEntitiesIterator::on_light ( light::LightState obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 46 of file list_entities.cpp.

◆ on_lock()

bool esphome::web_server::ListEntitiesIterator::on_lock ( lock::Lock obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 86 of file list_entities.cpp.

◆ on_number()

bool esphome::web_server::ListEntitiesIterator::on_number ( number::Number obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 113 of file list_entities.cpp.

◆ on_select()

bool esphome::web_server::ListEntitiesIterator::on_select ( select::Select obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 158 of file list_entities.cpp.

◆ on_sensor()

bool esphome::web_server::ListEntitiesIterator::on_sensor ( sensor::Sensor obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 54 of file list_entities.cpp.

◆ on_switch()

bool esphome::web_server::ListEntitiesIterator::on_switch ( switch_::Switch obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 62 of file list_entities.cpp.

◆ on_text()

bool esphome::web_server::ListEntitiesIterator::on_text ( text::Text obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 149 of file list_entities.cpp.

◆ on_text_sensor()

bool esphome::web_server::ListEntitiesIterator::on_text_sensor ( text_sensor::TextSensor obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 78 of file list_entities.cpp.

◆ on_time()

bool esphome::web_server::ListEntitiesIterator::on_time ( datetime::TimeEntity obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 131 of file list_entities.cpp.

◆ on_update()

bool esphome::web_server::ListEntitiesIterator::on_update ( update::UpdateEntity obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 186 of file list_entities.cpp.

◆ on_valve()

bool esphome::web_server::ListEntitiesIterator::on_valve ( valve::Valve obj)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 95 of file list_entities.cpp.

Field Documentation

◆ events_ [1/2]

DeferredUpdateEventSource* esphome::web_server::ListEntitiesIterator::events_
protected

Definition at line 94 of file list_entities.h.

◆ events_ [2/2]

esphome::web_server_idf::AsyncEventSource* esphome::web_server::ListEntitiesIterator::events_
protected

Definition at line 97 of file list_entities.h.

◆ web_server_

const WebServer* esphome::web_server::ListEntitiesIterator::web_server_
protected

Definition at line 92 of file list_entities.h.


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