GridMapCacheArray Class Reference

#include <GridMapCacheArray.h>

Public Member Functions
void	cacheData (int index, float val)
bool	containsCachedData (int index, float &val)
	GridMapCacheArray ()
void	resetCache ()
void	setMapSize (const Eigen::Vector2i &newDimensions)
	~GridMapCacheArray ()

Protected Member Functions
void	createCacheArray (const Eigen::Vector2i &newDimensions)
void	deleteCacheArray ()
void	setArraySize (const Eigen::Vector2i &newDimensions)

Protected Attributes
Eigen::Vector2i	arrayDimensions
	The size of the array. More...
CachedMapElement *	cacheArray
	Array used for caching data. More...
int	currCacheIndex
	The cache iteration index value. More...

Detailed Description

Caches filtered grid map accesses in a two dimensional array of the same size as the map.

Definition at line 44 of file GridMapCacheArray.h.

Constructor & Destructor Documentation

GridMapCacheArray()

GridMapCacheArray::GridMapCacheArray ( )

inline

Constructor

Definition at line 51 of file GridMapCacheArray.h.

~GridMapCacheArray()

GridMapCacheArray::~GridMapCacheArray ( )

inline

Destructor

Definition at line 61 of file GridMapCacheArray.h.

Member Function Documentation

cacheData()

void GridMapCacheArray::cacheData ( int  index, float  val  )

inline

Caches float value val for coordinates coords.

Parameters

coords	The coordinates
val	The value to be cached for coordinates.

Definition at line 97 of file GridMapCacheArray.h.

containsCachedData()

bool GridMapCacheArray::containsCachedData ( int  index, float &  val  )

inline

Checks wether cached data for coords is available. If this is the case, writes data into val.

Parameters

coords	The coordinates
val	Reference to a float the data is written to if available

Returns

Indicates if cached data is available

Definition at line 80 of file GridMapCacheArray.h.

createCacheArray()

void GridMapCacheArray::createCacheArray ( const Eigen::Vector2i &  newDimensions )

inlineprotected

Creates a cache array of size sizeIn.

Parameters

sizeIn

The size of the array

Definition at line 119 of file GridMapCacheArray.h.

deleteCacheArray()

void GridMapCacheArray::deleteCacheArray ( )

inlineprotected

Deletes the existing cache array.

Definition at line 138 of file GridMapCacheArray.h.

resetCache()

void GridMapCacheArray::resetCache ( )

inline

Resets/deletes the cached data

Definition at line 69 of file GridMapCacheArray.h.

setArraySize()

void GridMapCacheArray::setArraySize ( const Eigen::Vector2i &  newDimensions )

inlineprotected

Sets a new cache array size

Definition at line 146 of file GridMapCacheArray.h.

setMapSize()

void GridMapCacheArray::setMapSize ( const Eigen::Vector2i &  newDimensions )

inline

Sets the map size and resizes the cache array accordingly

Parameters

sizeIn

The map size.

Definition at line 108 of file GridMapCacheArray.h.

Member Data Documentation

arrayDimensions

Eigen::Vector2i GridMapCacheArray::arrayDimensions

protected

The size of the array.

Definition at line 162 of file GridMapCacheArray.h.

cacheArray

CachedMapElement* GridMapCacheArray::cacheArray

protected

Array used for caching data.

Definition at line 159 of file GridMapCacheArray.h.

currCacheIndex

int GridMapCacheArray::currCacheIndex

protected

The cache iteration index value.

Definition at line 160 of file GridMapCacheArray.h.

---

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

• GridMapCacheArray.h