Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

SimulationProxy Class Reference
[Proxies]

#include <playerclient.h>

Inherits ClientProxy.

List of all members.


Detailed Description

The SimulationProxy proxy provides access to a simulation device.


Public Member Functions

 SimulationProxy (PlayerClient *pc, unsigned short index, unsigned char access= 'c')
 ~SimulationProxy ()
int SetPose2D (char *identifier, double x, double y, double a)
int GetPose2D (char *identifier, double &x, double &y, double &a)
virtual void FillData (player_msghdr_t hdr, const char *buffer)
virtual void Print ()


Constructor & Destructor Documentation

SimulationProxy::SimulationProxy PlayerClient pc,
unsigned short  index,
unsigned char  access = 'c'
[inline]
 

constructor

SimulationProxy::~SimulationProxy  )  [inline]
 

destructor


Member Function Documentation

int SimulationProxy::SetPose2D char *  identifier,
double  x,
double  y,
double  a
 

set the 2D pose of an object in the simulator, identified by the string. Returns 0 on success, else a non-zero error code.

int SimulationProxy::GetPose2D char *  identifier,
double &  x,
double &  y,
double &  a
 

get the pose of an object in the simulator, identified by the string Returns 0 on success, else a non-zero error code.

virtual void SimulationProxy::FillData player_msghdr_t  hdr,
const char *  buffer
[virtual]
 

All proxies must provide this method. It is used internally to parse new data when it is received.

Reimplemented from ClientProxy.

virtual void SimulationProxy::Print  )  [virtual]
 

All proxies SHOULD provide this method, which should print out, in a human-readable form, the device's current state.

Reimplemented from ClientProxy.


The documentation for this class was generated from the following file:
Generated on Tue May 3 14:16:06 2005 for Player by doxygen 1.3.6