roo_transceivers
API Documentation for roo_transceivers
Loading...
Searching...
No Matches
roo_transceivers::ActuatorBinding Class Reference

#include <binding.h>

Public Member Functions

 ActuatorBinding (BindingStore &store, BindingStore::ActuatorKey key)
 
ActuatorLocator get () const
 Returns the bound locator (empty if unbound).
 
bool isBound () const
 Returns true when a locator is bound.
 
void bind (const ActuatorLocator &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 ActuatorBinding &binding)
 

Detailed Description

Definition at line 89 of file binding.h.

Constructor & Destructor Documentation

◆ ActuatorBinding()

roo_transceivers::ActuatorBinding::ActuatorBinding ( BindingStore store,
BindingStore::ActuatorKey  key 
)
inline

Definition at line 91 of file binding.h.

Member Function Documentation

◆ bind()

void roo_transceivers::ActuatorBinding::bind ( const ActuatorLocator loc)
inline

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

Definition at line 107 of file binding.h.

References roo_transceivers::BindingStore::clearActuatorBinding(), roo_transceivers::ActuatorLocator::isDefined(), and roo_transceivers::BindingStore::setActuatorBinding().

◆ get()

ActuatorLocator roo_transceivers::ActuatorBinding::get ( ) const
inline

Returns the bound locator (empty if unbound).

Definition at line 95 of file binding.h.

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

◆ isBound()

bool roo_transceivers::ActuatorBinding::isBound ( ) const
inline

Returns true when a locator is bound.

Definition at line 101 of file binding.h.

References roo_transceivers::ActuatorLocator::isDefined().

◆ unbind()

void roo_transceivers::ActuatorBinding::unbind ( )
inline

Clears the binding.

Definition at line 119 of file binding.h.

References roo_transceivers::BindingStore::clearActuatorBinding().

Friends And Related Symbol Documentation

◆ operator<<

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

Definition at line 22 of file binding.cpp.


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