PlayerCc::MapProxy Class Reference

The map proxy provides access to a map device. More...

#include <playerc++.h>

Inheritance diagram for PlayerCc::MapProxy:
PlayerCc::ClientProxy

List of all members.

Public Member Functions

 MapProxy (PlayerClient *aPc, uint32_t aIndex=0)
 constructor
 ~MapProxy ()
 destructor
void RequestMap ()
 Get the map and store it in the proxy.
int GetCellIndex (int x, int y) const
 Return the index of the (x,y) item in the cell array.
int8_t GetCell (int x, int y) const
 Get the (x,y) cell.
double GetResolution () const
 Map resolution, m/cell.
uint32_t GetWidth () const
 Map size, in cells.
uint32_t GetHeight () const
 Map size, in cells.
double GetOriginX () const
double GetOriginY () const
void GetMap (int8_t *aMap) const
 Occupancy for each cell (empty = -1, unknown = 0, occupied = +1)

Private Member Functions

void Subscribe (uint32_t aIndex)
void Unsubscribe ()

Private Attributes

playerc_map_tmDevice

Detailed Description

The map proxy provides access to a map device.


Member Function Documentation

uint32_t PlayerCc::MapProxy::GetHeight ( void  ) const [inline]

Map size, in cells.

Todo:
should this be returned as a player_size_t?
uint32_t PlayerCc::MapProxy::GetWidth ( void  ) const [inline]

Map size, in cells.

Todo:
should this be returned as a player_size_t?

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

Last updated 25 May 2011 21:17:00