Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

MapProxy Class Reference
[Proxies]

#include <playerclient.h>

Inherits ClientProxy.

List of all members.


Detailed Description

The map proxy provides access to a map device.


Public Member Functions

 MapProxy (PlayerClient *pc, unsigned short indes, unsigned char access='c')
 ~MapProxy ()
int GetMap ()
int GetCellIndex (int x, int y)
int GetCell (char *cell, int x, int y)
void FillData (player_msghdr_t hde, const char *buffer)

Public Attributes

double resolution
int width
int height
char * cells


Constructor & Destructor Documentation

MapProxy::MapProxy PlayerClient pc,
unsigned short  indes,
unsigned char  access = 'c'
 

MapProxy::~MapProxy  ) 
 


Member Function Documentation

int MapProxy::GetMap  ) 
 

Get the map, which is stored in the proxy

int MapProxy::GetCellIndex int  x,
int  y
 

Return the index of the (x,y) item in the cell array

int MapProxy::GetCell char *  cell,
int  x,
int  y
 

Get the (x,y) cell; returns 0 on success, -1 on failure (i.e., indexes out of bounds)

void MapProxy::FillData player_msghdr_t  hde,
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.


Member Data Documentation

double MapProxy::resolution
 

Map resolution, m/cell

int MapProxy::width
 

int MapProxy::height
 

char* MapProxy::cells
 

Occupancy for each cell (empty = -1, unknown = 0, occupied = +1)


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