PlayerCc::BlackBoardProxy Class Reference

The BlackBoardProxy class is used to subscribe to a blackboard device. More...

#include <playerc++.h>

Inheritance diagram for PlayerCc::BlackBoardProxy:

Collaboration diagram for PlayerCc::BlackBoardProxy:

Detailed Description

The BlackBoardProxy class is used to subscribe to a blackboard device.

A blackboard is a data-store which sends updates when an entry is changed. It also returns the current value of an entry when a proxy first subcribes to that entries key. If an entry does not exist, the default value of that entry is returned.

Public Member Functions
	BlackBoardProxy (PlayerClient *aPc, uint32_t aIndex=0)
	Constructor.
	~BlackBoardProxy ()
	Destructor.
player_blackboard_entry_t *	SubscribeToKey (const char *key, const char *group="")
	Subscribe to a key.
void	UnsubscribeFromKey (const char *key, const char *group="")
	Stop receiving updates about this key.
void	SubscribeToGroup (const char *key)
	Subscribe to a group.
void	UnsubscribeFromGroup (const char *group)
	Stop receiving updates about this group.
void	SetEntry (const player_blackboard_entry_t &entry)
	Set a key value.
player_blackboard_entry_t *	GetEntry (const char *key, const char *group)
	Get a value for a key.
void	SetEventHandler (void(*on_blackboard_event)(playerc_blackboard_t *, player_blackboard_entry_t))
	Set the function pointer which will be called when an entry is updated.
Public Member Functions inherited from PlayerCc::ClientProxy
bool	IsValid () const
	Proxy has any information.
bool	IsFresh () const
	Check for fresh data.
void	NotFresh ()
	Reset Fresh flag.
std::string	GetDriverName () const
	Get the underlying driver's name.
double	GetDataTime () const
	Returns the received timestamp of the last data sample [s].
double	GetElapsedTime () const
	Returns the time between the current data time and the time of the last data sample [s].
PlayerClient *	GetPlayerClient () const
	Get a pointer to the Player Client.
uint32_t	GetIndex () const
	Get device index.
uint32_t	GetInterface () const
	Get Interface Code.
std::string	GetInterfaceStr () const
	Get Interface Name.
void	SetReplaceRule (bool aReplace, int aType=-1, int aSubtype=-1)
	Set a replace rule for this proxy on the server.
int	HasCapability (uint32_t aType, uint32_t aSubtype)
	Request capabilities of device.
int	GetBoolProp (char *aProperty, bool *aValue)
	Request a boolean property.
int	SetBoolProp (char *aProperty, bool aValue)
	Set a boolean property.
int	GetIntProp (char *aProperty, int32_t *aValue)
	Request an integer property.
int	SetIntProp (char *aProperty, int32_t aValue)
	Set an integer property.
int	GetDblProp (char *aProperty, double *aValue)
	Request a double property.
int	SetDblProp (char *aProperty, double aValue)
	Set a double property.
int	GetStrProp (char *aProperty, char **aValue)
	Request a string property.
int	SetStrProp (char *aProperty, char *aValue)
	Set a string property.
template<typename T>
connection_t	ConnectReadSignal (T aSubscriber)
	Connect a read signal to this proxy.
void	DisconnectReadSignal (connection_t aSubscriber)
	Disconnect a signal from this proxy.

Private Member Functions
void	Subscribe (uint32_t aIndex)
void	Unsubscribe ()

Private Attributes
playerc_blackboard_t *	mDevice

Additional Inherited Members
Public Types inherited from PlayerCc::ClientProxy
typedef int	connection_t
typedef boost::mutex::scoped_lock	scoped_lock_t
typedef int	read_signal_t
Protected Member Functions inherited from PlayerCc::ClientProxy
	ClientProxy (PlayerClient *aPc, uint32_t aIndex)
template<typename T>
T	GetVar (const T &aV) const
template<typename T>
void	GetVarByRef (const T aBegin, const T aEnd, T aDest) const
Protected Attributes inherited from PlayerCc::ClientProxy
PlayerClient *	mPc
playerc_client_t *	mClient
playerc_device_t *	mInfo
bool	mFresh

Member Function Documentation

Subscribe()

void PlayerCc::BlackBoardProxy::Subscribe ( uint32_t aIndex )

privatevirtual

Reimplemented from PlayerCc::ClientProxy.

SubscribeToGroup()

void PlayerCc::BlackBoardProxy::SubscribeToGroup

(

const char *

key

)

Subscribe to a group.

The event handler must be set to retrieve the current group entries.

SubscribeToKey()

player_blackboard_entry_t * PlayerCc::BlackBoardProxy::SubscribeToKey	(	const char *	key,
		const char *	group = "" )

Subscribe to a key.

If the key does not exist the default value is returned. The user must free the entry.

Unsubscribe()

void PlayerCc::BlackBoardProxy::Unsubscribe ( )

privatevirtual

Reimplemented from PlayerCc::ClientProxy.

---

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

• playerc++.h