SensESP 2.7.2
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::SystemStatusController Class Reference

Base class for a controller that can react to system status events. More...

#include <sensesp/controllers/system_status_controller.h>

Inheritance diagram for sensesp::SystemStatusController:
[legend]

Public Member Functions

 SystemStatusController ()
 
virtual void set_input (WiFiState new_value, uint8_t input_channel=0) override
 
virtual void set_input (WSConnectionState new_value, uint8_t input_channel=0) override
 
- Public Member Functions inherited from sensesp::ValueConsumer< WiFiState >
void connect_from (ValueProducer< WiFiState > *producer, uint8_t input_channel=0)
 
- Public Member Functions inherited from sensesp::ValueConsumer< WSConnectionState >
void connect_from (ValueProducer< WSConnectionState > *producer, uint8_t input_channel=0)
 
- Public Member Functions inherited from sensesp::ValueProducer< SystemStatus >
 ValueProducer ()
 
virtual const SystemStatusget () const
 
void connect_to (ValueConsumer< SystemStatus > *consumer, uint8_t input_channel=0)
 
void connect_to (ValueConsumer< CT > *consumer, uint8_t input_channel=0)
 Connect a producer to a consumer of a different type.
 
Transform< SystemStatus, T2 > * connect_to (Transform< SystemStatus, T2 > *consumer_producer, uint8_t input_channel=0)
 
Transform< TT, T2 > * connect_to (Transform< TT, T2 > *consumer_producer, uint8_t input_channel=0)
 Connect a producer to a transform with a different input type.
 
void emit (SystemStatus new_value)
 
- Public Member Functions inherited from sensesp::Observable
 Observable ()
 
 Observable (Observable &&other)
 Move constructor.
 
void notify ()
 
void attach (std::function< void()> observer)
 

Protected Member Functions

void update_state (const SystemStatus new_state)
 

Additional Inherited Members

- Protected Attributes inherited from sensesp::ValueProducer< SystemStatus >
SystemStatus output
 

Detailed Description

Base class for a controller that can react to system status events.

Classes inheriting from SystemStatusController should override the set_wifi_* and set_ws_* methods to take the relevant action when such an event occurs.

Definition at line 27 of file system_status_controller.h.

Constructor & Destructor Documentation

◆ SystemStatusController()

sensesp::SystemStatusController::SystemStatusController ( )
inline

Definition at line 31 of file system_status_controller.h.

Member Function Documentation

◆ set_input() [1/2]

void sensesp::SystemStatusController::set_input ( WiFiState  new_value,
uint8_t  input_channel = 0 
)
overridevirtual

ValueConsumer interface for ValueConsumer<WiFiState> (Networking object state updates)

Reimplemented from sensesp::ValueConsumer< WiFiState >.

Definition at line 5 of file system_status_controller.cpp.

Here is the call graph for this function:

◆ set_input() [2/2]

void sensesp::SystemStatusController::set_input ( WSConnectionState  new_value,
uint8_t  input_channel = 0 
)
overridevirtual

ValueConsumer interface for ValueConsumer<WSConnectionState> (WSClient object state updates)

Reimplemented from sensesp::ValueConsumer< WSConnectionState >.

Definition at line 26 of file system_status_controller.cpp.

Here is the call graph for this function:

◆ update_state()

void sensesp::SystemStatusController::update_state ( const SystemStatus  new_state)
inlineprotected

Definition at line 43 of file system_status_controller.h.

Here is the call graph for this function:
Here is the caller graph for this function:

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