Public Member Functions | Protected Member Functions | Protected Attributes
GridMapCacheArray Class Reference

#include <GridMapCacheArray.h>

List of all members.

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.
CachedMapElementcacheArray
 Array used for caching data.
int currCacheIndex
 The cache iteration index value.

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

Constructor

Definition at line 51 of file GridMapCacheArray.h.

Destructor

Definition at line 61 of file GridMapCacheArray.h.


Member Function Documentation

void GridMapCacheArray::cacheData ( int  index,
float  val 
) [inline]

Caches float value val for coordinates coords.

Parameters:
coordsThe coordinates
valThe value to be cached for coordinates.

Definition at line 97 of file GridMapCacheArray.h.

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:
coordsThe coordinates
valReference 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.

void GridMapCacheArray::createCacheArray ( const Eigen::Vector2i &  newDimensions) [inline, protected]

Creates a cache array of size sizeIn.

Parameters:
sizeInThe size of the array

Definition at line 119 of file GridMapCacheArray.h.

void GridMapCacheArray::deleteCacheArray ( ) [inline, protected]

Deletes the existing cache array.

Definition at line 138 of file GridMapCacheArray.h.

void GridMapCacheArray::resetCache ( ) [inline]

Resets/deletes the cached data

Definition at line 69 of file GridMapCacheArray.h.

void GridMapCacheArray::setArraySize ( const Eigen::Vector2i &  newDimensions) [inline, protected]

Sets a new cache array size

Definition at line 146 of file GridMapCacheArray.h.

void GridMapCacheArray::setMapSize ( const Eigen::Vector2i &  newDimensions) [inline]

Sets the map size and resizes the cache array accordingly

Parameters:
sizeInThe map size.

Definition at line 108 of file GridMapCacheArray.h.


Member Data Documentation

Eigen::Vector2i GridMapCacheArray::arrayDimensions [protected]

The size of the array.

Definition at line 162 of file GridMapCacheArray.h.

Array used for caching data.

Definition at line 159 of file GridMapCacheArray.h.

The cache iteration index value.

Definition at line 160 of file GridMapCacheArray.h.


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


hector_mapping
Author(s): Stefan Kohlbrecher
autogenerated on Mon Oct 6 2014 00:33:51