roo_transceivers::SensorBinding Class Reference

Persistent binding of a sensor key to a locator. More...

#include <binding.h>

Public Member Functions
	SensorBinding (BindingStore &store, BindingStore::SensorKey key)
SensorLocator	get () const
	Returns the bound locator (empty if unbound).
bool	isBound () const
	Returns true when a locator is bound.
void	bind (const SensorLocator &loc)
	Binds to the specified locator (or unbinds when undefined).
void	unbind ()
	Clears the binding.

Friends
roo_logging::Stream &	operator<< (roo_logging::Stream &os, const SensorBinding &binding)

Detailed Description

Persistent binding of a sensor key to a locator.

Definition at line 13 of file binding.h.

Constructor & Destructor Documentation

SensorBinding()

roo_transceivers::SensorBinding::SensorBinding ( BindingStore &  store, BindingStore::SensorKey  key  )

inline

Definition at line 15 of file binding.h.

Member Function Documentation

bind()

void roo_transceivers::SensorBinding::bind ( const SensorLocator &  loc )

inline

Binds to the specified locator (or unbinds when undefined).

Definition at line 31 of file binding.h.

References roo_transceivers::BindingStore::clearSensorBinding(), roo_transceivers::SensorLocator::isDefined(), and roo_transceivers::BindingStore::setSensorBinding().

get()

SensorLocator roo_transceivers::SensorBinding::get ( ) const

inline

Returns the bound locator (empty if unbound).

Definition at line 19 of file binding.h.

Referenced by roo_transceivers::BoundSensor::read().

isBound()

bool roo_transceivers::SensorBinding::isBound ( ) const

inline

Returns true when a locator is bound.

Definition at line 25 of file binding.h.

References roo_transceivers::SensorLocator::isDefined().

unbind()

void roo_transceivers::SensorBinding::unbind ( )

inline

Clears the binding.

Definition at line 43 of file binding.h.

References roo_transceivers::BindingStore::clearSensorBinding().

Friends And Related Symbol Documentation

operator<<

roo_logging::Stream & operator<< ( roo_logging::Stream &  os, const SensorBinding &  binding  )

friend

Definition at line 5 of file binding.cpp.

---

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

• temp_repos/roo_transceivers/src/roo_transceivers/binding/binding.h