roo_transceivers::SensorLocator Class Reference

Identifies sensor within a transceiver device. More...

#include <id.h>

Public Member Functions
	SensorLocator ()
	SensorLocator (roo::string_view schema, roo::string_view device_id, roo::string_view sensor_id)
	SensorLocator (const DeviceLocator &device_loc, roo::string_view sensor_id)
const DeviceLocator &	device_locator () const
	Returns the device locator.
const DeviceSchema &	schema () const
	Returns the device schema.
const DeviceId &	device_id () const
	Returns the device id.
const SensorId &	sensor_id () const
	Returns the sensor id.
bool	isDefined () const
	Returns true if the locator is defined.
void	write_cstr (char *buf) const
	Writes a null-terminated string representation into buf.
std::string	toString () const
	Returns a string representation.

Detailed Description

Identifies sensor within a transceiver device.

Consists of device locator and sensor id.

Definition at line 57 of file id.h.

Constructor & Destructor Documentation

SensorLocator() [1/3]

roo_transceivers::SensorLocator::SensorLocator

(

)

Definition at line 26 of file id.cpp.

SensorLocator() [2/3]

roo_transceivers::SensorLocator::SensorLocator	(	roo::string_view	schema,
		roo::string_view	device_id,
		roo::string_view	sensor_id
	)

Definition at line 28 of file id.cpp.

SensorLocator() [3/3]

roo_transceivers::SensorLocator::SensorLocator	(	const DeviceLocator &	device_loc,
		roo::string_view	sensor_id
	)

Definition at line 33 of file id.cpp.

Member Function Documentation

device_id()

const DeviceId & roo_transceivers::SensorLocator::device_id ( ) const

inline

Returns the device id.

Definition at line 73 of file id.h.

References roo_transceivers::DeviceLocator::device_id().

Referenced by roo_transceivers::ArduinoPreferencesBindingStore::setSensorBinding().

device_locator()

const DeviceLocator & roo_transceivers::SensorLocator::device_locator ( ) const

inline

Returns the device locator.

Definition at line 67 of file id.h.

Referenced by isDefined(), operator<<(), roo_transceivers::operator==(), roo_transceivers::SimpleSensorUniverse::read(), roo_transceivers::TransceiverCollection::read(), and roo_transceivers::UniverseClient::read().

isDefined()

bool roo_transceivers::SensorLocator::isDefined ( ) const

inline

Returns true if the locator is defined.

Definition at line 79 of file id.h.

References device_locator(), and roo_transceivers::DeviceLocator::isDefined().

Referenced by roo_transceivers::SensorBinding::bind(), roo_transceivers::SensorBinding::isBound(), and roo_transceivers::BoundSensor::read().

schema()

const DeviceSchema & roo_transceivers::SensorLocator::schema ( ) const

inline

Returns the device schema.

Definition at line 70 of file id.h.

References roo_transceivers::DeviceLocator::schema().

Referenced by roo_transceivers::ArduinoPreferencesBindingStore::setSensorBinding().

sensor_id()

const SensorId & roo_transceivers::SensorLocator::sensor_id ( ) const

inline

Returns the sensor id.

Definition at line 76 of file id.h.

Referenced by operator<<(), roo_transceivers::operator==(), roo_transceivers::SimpleSensorUniverse::read(), roo_transceivers::TransceiverCollection::read(), and roo_transceivers::ArduinoPreferencesBindingStore::setSensorBinding().

toString()

std::string roo_transceivers::SensorLocator::toString

(

)

const

Returns a string representation.

Definition at line 46 of file id.cpp.

References write_cstr().

write_cstr()

void roo_transceivers::SensorLocator::write_cstr

(

char *

buf

)

const

Writes a null-terminated string representation into buf.

Definition at line 37 of file id.cpp.

References roo_transceivers::DeviceLocator::write_cstr().

Referenced by toString().

---

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

• temp_repos/roo_transceivers/src/roo_transceivers/id.h
• temp_repos/roo_transceivers/src/roo_transceivers/id.cpp