The IrProxy class is used to control an interface_ir device. More...

#include <playerc++.h>

Inheritance diagram for PlayerCc::IrProxy:
Inheritance graph
Collaboration diagram for PlayerCc::IrProxy:
Collaboration graph

Detailed Description

The IrProxy class is used to control an interface_ir device.

Public Member Functions

 IrProxy (PlayerClient *aPc, uint32_t aIndex=0)
 Constructor.
 
 ~IrProxy ()
 Destructor.
 
uint32_t GetCount () const
 get the number of IR rangers
 
double GetRange (uint32_t aIndex) const
 get the current range
 
double GetVoltage (uint32_t aIndex) const
 get the current voltage
 
uint32_t GetPoseCount () const
 get the number of poses
 
player_pose3d_t GetPose (uint32_t aIndex) const
 get a particular pose
 
void RequestGeom ()
 Request IR pose information.
 
double operator[] (uint32_t aIndex) const
 Range access operator.
 
- 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].
 
PlayerClientGetPlayerClient () 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_ir_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)
 
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
 

Member Function Documentation

◆ operator[]()

double PlayerCc::IrProxy::operator[] ( uint32_t aIndex) const
inline

Range access operator.

This operator provides an alternate way of access the range data. For example, given a IrProxy named ip, the following expressions are equivalent: ip.GetRange[0] and ip[0].

◆ Subscribe()

void PlayerCc::IrProxy::Subscribe ( uint32_t aIndex)
privatevirtual

Reimplemented from PlayerCc::ClientProxy.

◆ Unsubscribe()

void PlayerCc::IrProxy::Unsubscribe ( )
privatevirtual

Reimplemented from PlayerCc::ClientProxy.


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