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>
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.
Public Member Functions | |
BlobfinderProxy (PlayerClient *aPc, uint32_t aIndex=0) | |
Constructor. | |
~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. More... | |
Public Member Functions inherited from PlayerCc::ClientProxy | |
bool | IsValid () const |
Proxy has any information. More... | |
bool | IsFresh () const |
Check for fresh data. More... | |
void | NotFresh () |
Reset Fresh flag. More... | |
std::string | GetDriverName () const |
Get the underlying driver's name. More... | |
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. More... | |
uint32_t | GetIndex () const |
Get device index. More... | |
uint32_t | GetInterface () const |
Get Interface Code. More... | |
std::string | GetInterfaceStr () const |
Get Interface Name. More... | |
void | SetReplaceRule (bool aReplace, int aType=-1, int aSubtype=-1) |
Set a replace rule for this proxy on the server. More... | |
int | HasCapability (uint32_t aType, uint32_t aSubtype) |
Request capabilities of device. More... | |
int | GetBoolProp (char *aProperty, bool *aValue) |
Request a boolean property. More... | |
int | SetBoolProp (char *aProperty, bool aValue) |
Set a boolean property. More... | |
int | GetIntProp (char *aProperty, int32_t *aValue) |
Request an integer property. More... | |
int | SetIntProp (char *aProperty, int32_t aValue) |
Set an integer property. More... | |
int | GetDblProp (char *aProperty, double *aValue) |
Request a double property. More... | |
int | SetDblProp (char *aProperty, double aValue) |
Set a double property. More... | |
int | GetStrProp (char *aProperty, char **aValue) |
Request a string property. More... | |
int | SetStrProp (char *aProperty, char *aValue) |
Set a string property. More... | |
template<typename T > | |
connection_t | ConnectReadSignal (T aSubscriber) |
Connect a read signal to this proxy. More... | |
void | DisconnectReadSignal (connection_t aSubscriber) |
Disconnect a signal from this proxy. More... | |
Private Member Functions | |
void | Subscribe (uint32_t aIndex) |
void | Unsubscribe () |
Private Attributes | |
playerc_blobfinder_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
◆ operator[]()
|
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: