Grid2D< CellType > Class Template Reference

#include <Grid2D.h>

Inheritance diagram for Grid2D< CellType >:

List of all members.

Public Types
typedef std::vector< CellType >	Cells
typedef std::pair< unsigned int, unsigned int >	Indices
typedef std::pair< int, int >	SignedIndices
typedef CellType	value_type
Public Member Functions
const Cells &	getCells () const
Cells &	getCells ()
const unsigned int &	getHeight () const
void	getNeighbors (Cells &cells, const SignedIndices &indices, unsigned int neighborhoodRadius) const
const unsigned int &	getWidth () const
	Grid2D ()
	Grid2D (const unsigned int &width, const unsigned int &height, const CellType &c=CellType())
Cells::const_reference	operator() (unsigned int w, unsigned int h) const
Cells::reference	operator() (unsigned int w, unsigned int h)
Cells::const_reference	operator() (const Indices &indices) const
Cells::reference	operator() (const Indices &indices)
Static Protected Member Functions
static unsigned int	getIndex (unsigned int w, unsigned int h, unsigned int width)
Protected Attributes
Cells	mGrid
unsigned int	mHeight
unsigned int	mWidth

---

Detailed Description

template<typename CellType>
class Grid2D< CellType >

Definition at line 44 of file Grid2D.h.

---

Member Typedef Documentation

template<typename CellType>

typedef std::vector<CellType> Grid2D< CellType >::Cells

Reimplemented in PositionedGrid2D< CellType >, and PositionedGrid2D< NodeGridCell >.

Definition at line 47 of file Grid2D.h.

template<typename CellType>

typedef std::pair<unsigned int, unsigned int> Grid2D< CellType >::Indices

Reimplemented in PositionedGrid2D< CellType >, and PositionedGrid2D< NodeGridCell >.

Definition at line 48 of file Grid2D.h.

template<typename CellType>

typedef std::pair<int, int> Grid2D< CellType >::SignedIndices

Reimplemented in PositionedGrid2D< CellType >, and PositionedGrid2D< NodeGridCell >.

Definition at line 49 of file Grid2D.h.

template<typename CellType>

typedef CellType Grid2D< CellType >::value_type

Definition at line 46 of file Grid2D.h.

---

Constructor & Destructor Documentation

template<typename CellType>

Grid2D< CellType >::Grid2D

(

)

[inline]

Definition at line 52 of file Grid2D.h.

template<typename CellType>

Grid2D< CellType >::Grid2D	(	const unsigned int &	width,
		const unsigned int &	height,
		const CellType &	c = CellType()
	)		[inline]

Definition at line 54 of file Grid2D.h.

---

Member Function Documentation

template<typename CellType>

const Cells& Grid2D< CellType >::getCells

(

)

const [inline]

Definition at line 61 of file Grid2D.h.

template<typename CellType>

Cells& Grid2D< CellType >::getCells

(

)

[inline]

Definition at line 62 of file Grid2D.h.

template<typename CellType>

const unsigned int& Grid2D< CellType >::getHeight

(

)

const [inline]

Definition at line 60 of file Grid2D.h.

template<typename CellType>

static unsigned int Grid2D< CellType >::getIndex	(	unsigned int	w,
		unsigned int	h,
		unsigned int	width
	)		[inline, static, protected]

Definition at line 85 of file Grid2D.h.

template<typename CellType>

void Grid2D< CellType >::getNeighbors	(	Cells &	cells,
		const SignedIndices &	indices,
		unsigned int	neighborhoodRadius
	)		const [inline]

Definition at line 70 of file Grid2D.h.

template<typename CellType>

const unsigned int& Grid2D< CellType >::getWidth

(

)

const [inline]

Definition at line 59 of file Grid2D.h.

template<typename CellType>

Cells::const_reference Grid2D< CellType >::operator()	(	unsigned int	w,
		unsigned int	h
	)		const [inline]

Definition at line 64 of file Grid2D.h.

template<typename CellType>

Cells::reference Grid2D< CellType >::operator()	(	unsigned int	w,
		unsigned int	h
	)		[inline]

Definition at line 65 of file Grid2D.h.

template<typename CellType>

Cells::const_reference Grid2D< CellType >::operator()

(

const Indices &

indices

)

const [inline]

Definition at line 66 of file Grid2D.h.

template<typename CellType>

Cells::reference Grid2D< CellType >::operator()

(

const Indices &

indices

)

[inline]

Definition at line 67 of file Grid2D.h.

---

Member Data Documentation

template<typename CellType>

Cells Grid2D< CellType >::mGrid [protected]

Definition at line 89 of file Grid2D.h.

template<typename CellType>

unsigned int Grid2D< CellType >::mHeight [protected]

Definition at line 91 of file Grid2D.h.

template<typename CellType>

unsigned int Grid2D< CellType >::mWidth [protected]

Definition at line 90 of file Grid2D.h.

---

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

• Grid2D.h