Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

LocalizeProxy Class Reference
[Proxies]

#include <playerclient.h>

Inherits ClientProxy.

List of all members.


Detailed Description

The LocalizeProxy class is used to control a localize device, which can provide multiple pose hypotheses for a robot.


Public Member Functions

 LocalizeProxy (PlayerClient *pc, unsigned short index, unsigned char access= 'c')
 ~LocalizeProxy ()
void FillData (player_msghdr_t hdr, const char *buffer)
int SetPose (double pose[3], double cov[3][3])
int GetNumParticles ()
void Print ()
 Print out current hypotheses.


Public Attributes

unsigned int map_size_x
 Map dimensions (cells).

unsigned int map_size_y
 Map dimensions (cells).

double map_scale
 Map scale (m/cell).

int8_t * map_cells
 Map data (empty = -1, unknown = 0, occupied = +1).

int pending_count
 Number of pending (unprocessed) sensor readings.

int hypoth_count
 Number of possible poses.

localize_hypoth hypoths [PLAYER_LOCALIZE_MAX_HYPOTHS]


Constructor & Destructor Documentation

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

Constructor. Leave the access field empty to start unconnected.

LocalizeProxy::~LocalizeProxy  ) 
 


Member Function Documentation

void LocalizeProxy::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.

int LocalizeProxy::SetPose double  pose[3],
double  cov[3][3]
 

Set the current pose hypothesis (m, m, radians). Returns 0 on success, -1 on error.

int LocalizeProxy::GetNumParticles  ) 
 

Get the number of particles (for particle filter-based localization systems). Returns the number of particles, or -1 on error.

void LocalizeProxy::Print  )  [virtual]
 

Print out current hypotheses.

Reimplemented from ClientProxy.


Member Data Documentation

unsigned int LocalizeProxy::map_size_x
 

Map dimensions (cells).

unsigned int LocalizeProxy::map_size_y
 

Map dimensions (cells).

double LocalizeProxy::map_scale
 

Map scale (m/cell).

int8_t* LocalizeProxy::map_cells
 

Map data (empty = -1, unknown = 0, occupied = +1).

int LocalizeProxy::pending_count
 

Number of pending (unprocessed) sensor readings.

int LocalizeProxy::hypoth_count
 

Number of possible poses.

localize_hypoth LocalizeProxy::hypoths[PLAYER_LOCALIZE_MAX_HYPOTHS]
 

Array of possible poses.


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