roo_transceivers::ActuatorLocator Class Reference

Identifies actuator within a transceiver device. More...

#include <id.h>

Public Member Functions
	ActuatorLocator ()
	ActuatorLocator (const DeviceLocator &device_loc, roo::string_view actuator_id)
	ActuatorLocator (roo::string_view schema, roo::string_view device_id, roo::string_view actuator_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 ActuatorId &	actuator_id () const
	Returns the actuator 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 actuator within a transceiver device.

Consists of device locator and actuator id.

Definition at line 104 of file id.h.

Constructor & Destructor Documentation

ActuatorLocator() [1/3]

roo_transceivers::ActuatorLocator::ActuatorLocator

(

)

Definition at line 53 of file id.cpp.

ActuatorLocator() [2/3]

roo_transceivers::ActuatorLocator::ActuatorLocator	(	const DeviceLocator &	device_loc,
		roo::string_view	actuator_id
	)

Definition at line 55 of file id.cpp.

ActuatorLocator() [3/3]

roo_transceivers::ActuatorLocator::ActuatorLocator	(	roo::string_view	schema,
		roo::string_view	device_id,
		roo::string_view	actuator_id
	)

Definition at line 59 of file id.cpp.

Member Function Documentation

actuator_id()

const ActuatorId & roo_transceivers::ActuatorLocator::actuator_id ( ) const

inline

Returns the actuator id.

Definition at line 124 of file id.h.

Referenced by roo_transceivers::proto::ClientWrite(), operator<<(), roo_transceivers::operator==(), roo_transceivers::BoundSensingActuator::read(), roo_transceivers::ArduinoPreferencesBindingStore::setActuatorBinding(), and roo_transceivers::TransceiverCollection::write().

device_id()

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

inline

Returns the device id.

Definition at line 121 of file id.h.

References roo_transceivers::DeviceLocator::device_id().

Referenced by roo_transceivers::proto::ClientWrite(), and roo_transceivers::ArduinoPreferencesBindingStore::setActuatorBinding().

device_locator()

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

inline

Returns the device locator.

Definition at line 115 of file id.h.

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

isDefined()

bool roo_transceivers::ActuatorLocator::isDefined ( ) const

inline

Returns true if the locator is defined.

Definition at line 127 of file id.h.

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

Referenced by roo_transceivers::ActuatorBinding::bind(), roo_transceivers::ActuatorBinding::isBound(), roo_transceivers::BoundSensingActuator::read(), roo_transceivers::BoundActuator::write(), and roo_transceivers::BoundSensingActuator::write().

schema()

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

inline

Returns the device schema.

Definition at line 118 of file id.h.

References roo_transceivers::DeviceLocator::schema().

Referenced by roo_transceivers::proto::ClientWrite(), and roo_transceivers::ArduinoPreferencesBindingStore::setActuatorBinding().

toString()

std::string roo_transceivers::ActuatorLocator::toString

(

)

const

Returns a string representation.

Definition at line 73 of file id.cpp.

References write_cstr().

write_cstr()

void roo_transceivers::ActuatorLocator::write_cstr

(

char *

buf

)

const

Writes a null-terminated string representation into buf.

Definition at line 64 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