roo_transceivers
API Documentation for roo_transceivers
Loading...
Searching...
No Matches
roo_transceivers::SimpleSensor Class Referenceabstract

Transceiver exposing one statically defined sensor and no actuators. More...

#include <transceiver_collection.h>

Inheritance diagram for roo_transceivers::SimpleSensor:
[legend]
Collaboration diagram for roo_transceivers::SimpleSensor:
[legend]

Public Member Functions

 SimpleSensor (roo_transceivers_Quantity quantity, SensorId id="")
 Constructs single-sensor transceiver metadata.
 
void getDescriptor (roo_transceivers_Descriptor &descriptor) const override
 
Measurement read (const SensorId &sensor) const override
 
bool write (const ActuatorId &actuator, float value) override
 
void addEventListener (EventListener *listener) override
 
void removeEventListener (EventListener *listener) override
 
- Public Member Functions inherited from roo_transceivers::Transceiver
 Transceiver ()=default
 
virtual ~Transceiver ()=default
 
virtual void requestUpdate ()
 

Protected Member Functions

virtual float readFromSensor () const =0
 
void notifyNewReadingsAvailable () const
 

Protected Attributes

roo_transceivers_Quantity quantity_
 
SensorId id_
 
roo_collections::FlatSmallHashSet< EventListener * > event_listeners_
 

Detailed Description

Transceiver exposing one statically defined sensor and no actuators.

Provides validated defaults and listener management.

Definition at line 227 of file transceiver_collection.h.

Constructor & Destructor Documentation

◆ SimpleSensor()

roo_transceivers::SimpleSensor::SimpleSensor ( roo_transceivers_Quantity  quantity,
SensorId  id = "" 
)
inline

Constructs single-sensor transceiver metadata.

Definition at line 230 of file transceiver_collection.h.

Member Function Documentation

◆ addEventListener()

void roo_transceivers::SimpleSensor::addEventListener ( EventListener listener)
inlineoverridevirtual

Implements roo_transceivers::Transceiver.

Definition at line 247 of file transceiver_collection.h.

References event_listeners_.

◆ getDescriptor()

◆ notifyNewReadingsAvailable()

void roo_transceivers::SimpleSensor::notifyNewReadingsAvailable ( ) const
inlineprotected

Definition at line 258 of file transceiver_collection.h.

References event_listeners_.

◆ read()

Measurement roo_transceivers::SimpleSensor::read ( const SensorId sensor) const
inlineoverridevirtual

Implements roo_transceivers::Transceiver.

Definition at line 240 of file transceiver_collection.h.

References id_, quantity_, and readFromSensor().

◆ readFromSensor()

virtual float roo_transceivers::SimpleSensor::readFromSensor ( ) const
protectedpure virtual

Referenced by read().

◆ removeEventListener()

void roo_transceivers::SimpleSensor::removeEventListener ( EventListener listener)
inlineoverridevirtual

Implements roo_transceivers::Transceiver.

Definition at line 251 of file transceiver_collection.h.

References event_listeners_.

◆ write()

bool roo_transceivers::SimpleSensor::write ( const ActuatorId actuator,
float  value 
)
inlineoverridevirtual

Implements roo_transceivers::Transceiver.

Definition at line 245 of file transceiver_collection.h.

Field Documentation

◆ event_listeners_

roo_collections::FlatSmallHashSet<EventListener*> roo_transceivers::SimpleSensor::event_listeners_
protected

◆ id_

SensorId roo_transceivers::SimpleSensor::id_
protected

Definition at line 265 of file transceiver_collection.h.

Referenced by getDescriptor(), and read().

◆ quantity_

roo_transceivers_Quantity roo_transceivers::SimpleSensor::quantity_
protected

Definition at line 264 of file transceiver_collection.h.

Referenced by getDescriptor(), and read().


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