roo_transceivers::OneWireUniverse Class Reference

Universe adapter exposing OneWire thermometers as transceivers. More...

#include <onewire.h>

Inheritance diagram for roo_transceivers::OneWireUniverse:

Collaboration diagram for roo_transceivers::OneWireUniverse:

Public Member Functions
	OneWireUniverse (roo_onewire::OneWire &onewire)
size_t	deviceCount () const override
	Returns the total number of transceiver devices in this universe.
bool	forEachDevice (std::function< bool(const DeviceLocator &)> callback) const
	Iterates over all transceiver devices in this universe, calling callback for each device.
Measurement	readSensor (const DeviceLocator &locator) const override
roo_transceivers_Quantity	getSensorQuantity (DeviceLocator device_locator) const override
void	requestUpdate () override
	Requests sensor reading update from underlying devices.
void	addEventListener (EventListener *listener) override
	Registers a listener for device-set and reading update events.
void	removeEventListener (EventListener *listener) override
	Removes a previously registered event listener.
Public Member Functions inherited from roo_transceivers::SimpleSensorUniverse
bool	getDeviceDescriptor (const DeviceLocator &locator, roo_transceivers_Descriptor &descriptor) const override
	Synthesizes a single-sensor descriptor for locator.
Measurement	read (const SensorLocator &locator) const override
	Reads the single sensor of a device.
bool	write (const ActuatorLocator &locator, float value) override
	This universe is sensor-only; writes are always rejected.
Public Member Functions inherited from roo_transceivers::Universe
virtual	~Universe ()=default

Additional Inherited Members

Detailed Description

Universe adapter exposing OneWire thermometers as transceivers.

Definition at line 19 of file onewire.h.

Constructor & Destructor Documentation

OneWireUniverse()

roo_transceivers::OneWireUniverse::OneWireUniverse ( roo_onewire::OneWire &  onewire )

inline

Definition at line 21 of file onewire.h.

Member Function Documentation

addEventListener()

void roo_transceivers::OneWireUniverse::addEventListener ( EventListener *  listener )

inlineoverridevirtual

Registers a listener for device-set and reading update events.

Reimplemented from roo_transceivers::Universe.

Definition at line 64 of file onewire.h.

deviceCount()

size_t roo_transceivers::OneWireUniverse::deviceCount ( ) const

inlineoverridevirtual

Returns the total number of transceiver devices in this universe.

Implements roo_transceivers::Universe.

Definition at line 26 of file onewire.h.

forEachDevice()

bool roo_transceivers::OneWireUniverse::forEachDevice ( std::function< bool(const DeviceLocator &)>  callback ) const

inlinevirtual

Iterates over all transceiver devices in this universe, calling callback for each device.

Callback return value controls iteration:

• true => continue iterating,
• false => interrupt iteration.

Returns true if iteration completed (callback returned true for all devices), and false if interrupted by callback.

Implements roo_transceivers::Universe.

Definition at line 30 of file onewire.h.

getSensorQuantity()

roo_transceivers_Quantity roo_transceivers::OneWireUniverse::getSensorQuantity ( DeviceLocator  device_locator ) const

inlineoverridevirtual

Implements roo_transceivers::SimpleSensorUniverse.

Definition at line 54 of file onewire.h.

References roo_transceivers_Quantity_kTemperature, roo_transceivers_Quantity_kUnspecifiedQuantity, and roo_transceivers::DeviceLocator::schema().

readSensor()

Measurement roo_transceivers::OneWireUniverse::readSensor ( const DeviceLocator &  locator ) const

inlineoverridevirtual

Implements roo_transceivers::SimpleSensorUniverse.

Definition at line 41 of file onewire.h.

References roo_transceivers::DeviceLocator::device_id(), roo_transceivers_Quantity_kTemperature, and roo_transceivers::DeviceLocator::schema().

removeEventListener()

void roo_transceivers::OneWireUniverse::removeEventListener ( EventListener *  listener )

inlineoverridevirtual

Removes a previously registered event listener.

Reimplemented from roo_transceivers::Universe.

Definition at line 70 of file onewire.h.

requestUpdate()

void roo_transceivers::OneWireUniverse::requestUpdate ( )

inlineoverridevirtual

Requests sensor reading update from underlying devices.

Implements roo_transceivers::Universe.

Definition at line 62 of file onewire.h.

---

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

• temp_repos/roo_transceivers/src/roo_transceivers/onewire/onewire.h