The CoopObjectProxy
class is used to control a coopobject device.
|
| CoopObjectProxy (PlayerClient *aPc, uint32_t aIndex=0) |
| Constructor.
|
|
| ~CoopObjectProxy () |
| Destructor.
|
|
int | MessageType () const |
| Message type Possible values include. More...
|
|
uint32_t | GetOrigin () const |
| Cooperating Object type Possible values include. More...
|
|
uint32_t | GetID () const |
| Cooperating Object ID.
|
|
uint32_t | GetParentID () const |
| Cooperating Object Parent ID.
|
|
uint32_t | GetProxyID () const |
| Get robot ID.
|
|
void | SetProxyID (uint32_t value) |
| Set robot ID.
|
|
uint32_t | GetSensorNumber () const |
| Get number of sensors included in the message.
|
|
uint8_t | GetSensorType (uint32_t index) const |
| Sensor type Possible values include. More...
|
|
uint16_t | GetSensorData (uint32_t index) const |
| Sensor value.
|
|
uint32_t | GetAlarmNumber () const |
| Get number of alarms included in the message.
|
|
uint8_t | GetAlarmType (uint32_t index) const |
| Alarm type Possible values include. More...
|
|
uint16_t | GetAlarmData (uint32_t index) const |
| Alarm value.
|
|
uint32_t | GetUserDataNumber () const |
| Get number of bytes of user defined data.
|
|
uint8_t * | GetAllUserData () const |
| User defined data array.
|
|
uint8_t | GetUserData (uint32_t index) const |
| Indexed user defined byte.
|
|
uint16_t | GetRSSIsenderId () const |
| Radio Signal Strength sender ID.
|
|
uint16_t | GetRSSIvalue () const |
| Radio Signal Strength value.
|
|
uint16_t | GetRSSIstamp () const |
| Radio Signal Strength message timestamp.
|
|
double | GetRSSInodeTime () const |
| Radio Signal Strength Cooperating Object timestamp.
|
|
float | GetX () const |
| Cooperating Object X position.
|
|
float | GetY () const |
| Cooperating Object Y position.
|
|
float | GetZ () const |
| Cooperating Object Z position.
|
|
uint8_t | GetStatus () const |
| Cooperating Object status.
|
|
uint32_t | GetRequest () const |
| Request type.
|
|
uint32_t | GetCommand () const |
| Command type.
|
|
uint32_t | GetParametersSize () const |
| Request/Command parameter array size (in bytes)
|
|
uint8_t * | GetAllParameters () const |
| Request/Command parameter array.
|
|
uint8_t | GetParameter (uint32_t index) const |
| Indexed user defined byte.
|
|
void | SendData (int destID, int sourceID, player_pose2d_t pos, int status) |
| Send user data to Cooperating Object.
|
|
void | SendData (int destID, int sourceID, int extradata_type, uint32_t extradata_size, uint8_t *extradata) |
| Send user data to Cooperating Object.
|
|
void | SendCommand (int destID, int sourceID, int command, uint32_t cmd_parameters_size=0, uint8_t *cmd_parameters=NULL) |
| Send command to Cooperating Object.
|
|
void | SendRequest (int destID, int sourceID, int request, uint32_t req_parameters_size=0, uint8_t *req_parameters=NULL) |
| Send request to Cooperating Object.
|
|
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...
|
|