Public Member Functions | Private Member Functions | Private Attributes | List of all members
PlayerCc::BlobfinderProxy Class Reference

The BlinkenlightProxy class is used to enable and disable a flashing indicator light, and to set its period, via a blinkenlight device. More...

#include <playerc++.h>

Inheritance diagram for PlayerCc::BlobfinderProxy:
PlayerCc::ClientProxy

Public Member Functions

 BlobfinderProxy (PlayerClient *aPc, uint32_t aIndex=0)
 default contsructor
 ~BlobfinderProxy ()
 destructor
uint32_t GetCount () const
 returns the number of blobs
playerc_blobfinder_blob_t GetBlob (uint32_t aIndex) const
 returns a blob
uint32_t GetWidth () const
 get the width of the image
uint32_t GetHeight () const
 get the height of the image
playerc_blobfinder_blob_t operator[] (uint32_t aIndex) const
 Blobfinder data access operator.
- Public Member Functions inherited from PlayerCc::ClientProxy
bool IsValid () const
 Returns true if we have received any data from the device.
bool IsFresh () const
 Fresh is set to true on each new read.
void NotFresh ()
 This states that the data in a client is currently not Fresh.
std::string GetDriverName () const
 Returns the driver name.
double GetDataTime () const
 Returns the received timestamp [s].
double GetElapsedTime () const
 Returns the received timestamp [s].
PlayerClientGetPlayerClient () const
 Returns a pointer to the Player Client.
uint32_t GetIndex () const
 Returns device index.
uint32_t GetInterface () const
 Returns device interface.
std::string GetInterfaceStr () const
 Returns device interface.
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 signal to this proxy For more information check out Signals & multithreading.
void DisconnectReadSignal (connection_t aSubscriber)
 Disconnect a signal to this proxy.

Private Member Functions

void Subscribe (uint32_t aIndex)
void Unsubscribe ()

Private Attributes

playerc_blobfinder_tmDevice

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)
virtual void Subscribe (uint32_t)
virtual void Unsubscribe ()
template<typename 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
PlayerClientmPc
playerc_client_tmClient
playerc_device_tmInfo
bool mFresh

Detailed Description

The BlinkenlightProxy class is used to enable and disable a flashing indicator light, and to set its period, via a blinkenlight device.

       Constructor.

Leave the access field empty to start unconnected. The current period (one whole on/off cycle) of the blinking light. If the period is zero and the light is enabled, the light is on. Set the state of the indicator light. A period of zero means the light will be unblinkingly on or off. Returns 0 on success, else -1. The BlobfinderProxy class is used to control a blobfinder device. It contains no methods. The latest color blob data is stored in blobs, a dynamically allocated 2-D array, indexed by color channel.

Member Function Documentation

playerc_blobfinder_blob_t PlayerCc::BlobfinderProxy::operator[] ( uint32_t  aIndex) const
inline

Blobfinder data access operator.

This operator provides an alternate way of access the actuator data. For example, given a BlobfinderProxy named bp, the following expressions are equivalent: bp.GetBlob[0] and bp[0].


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

Last updated 12 September 2005 21:38:45