bil::V5CfgTileMap Class Reference

Holds V5CfgTileMapEntry instances for a grid of tiles. More...

#include <correlation/cfgextraction/V5CfgTileMap.hpp>

List of all members.

Public Member Functions
	V5CfgTileMap ()
	Constructs a new V5CfgTileMap instance.
unsigned	rowCount () const
	Gets the number of tile rows.
unsigned	columnCount () const
	Gets the number of tile columns.
V5CfgTileMapEntry &	entries (unsigned row, unsigned column)
	Gets V5CfgTileMapEntry for specified tile position.
const V5CfgTileMapEntry &	entries (unsigned row, unsigned column) const
	Gets V5CfgTileMapEntry for specified tile position read only.
void	resize (unsigned rowCount, unsigned columnCount)
	Resize the tile grid.
void	clear ()
	Empties tile grid and erases all data.

Friends
void	writeBinary (const V5CfgTileMap &data, std::ostream &outputStream)
	Writes data from a V5CfgTileMap into a binary stream.
void	readBinary (V5CfgTileMap &data, std::istream &inputStream)
	Reads data into a V5CfgTileMap from a binary stream.

---

Detailed Description

Holds V5CfgTileMapEntry instances for a grid of tiles.

A 2-dimensional container for V5CfgTileMapEntry instances. Every grid position holds a V5CfgTileMapEntry instance for the corresponding tile.

Definition at line 24 of file V5CfgTileMap.hpp.

---

Constructor & Destructor Documentation

V5CfgTileMap::V5CfgTileMap

(

)

Constructs a new V5CfgTileMap instance.

Definition at line 12 of file V5CfgTileMap.cpp.

---

Member Function Documentation

unsigned V5CfgTileMap::rowCount

(

)

const

Gets the number of tile rows.

Returns:

The row count.

Definition at line 21 of file V5CfgTileMap.cpp.

unsigned V5CfgTileMap::columnCount

(

)

const

Gets the number of tile columns.

Returns:

The column count.

Definition at line 27 of file V5CfgTileMap.cpp.

V5CfgTileMapEntry & V5CfgTileMap::entries	(	unsigned	row,
		unsigned	column
	)

Gets V5CfgTileMapEntry for specified tile position.

Parameters:

row	Row of tile.
column	Column of tile.

Returns:

The V5CfgTileMapEntry instance.

Exceptions:

.

Definition at line 33 of file V5CfgTileMap.cpp.

const V5CfgTileMapEntry & V5CfgTileMap::entries	(	unsigned	row,
		unsigned	column
	)		const

Gets V5CfgTileMapEntry for specified tile position read only.

Parameters:

row	Row of tile.
column	Column of tile.

Returns:

The V5CfgTileMapEntry instance.

Exceptions:

.

Definition at line 41 of file V5CfgTileMap.cpp.

void V5CfgTileMap::resize	(	unsigned	rowCount,
		unsigned	columnCount
	)

Resize the tile grid.

Resizing the grid will reset all contained data.

Parameters:

rowCount	The new row number of tiles.
columnCount	The new column number of tiles.

Definition at line 49 of file V5CfgTileMap.cpp.

void V5CfgTileMap::clear

(

)

Empties tile grid and erases all data.

Definition at line 62 of file V5CfgTileMap.cpp.

---

Friends And Related Function Documentation

void writeBinary ( const V5CfgTileMap &  data, std::ostream &  outputStream  )

friend

Writes data from a V5CfgTileMap into a binary stream.

Parameters:

data	The V5CfgTileMap to write.
outputStream	The stream to write into.

Exceptions:

.

void readBinary ( V5CfgTileMap &  data, std::istream &  inputStream  )

friend

Reads data into a V5CfgTileMap from a binary stream.

Parameters:

data	The V5CfgTileMap to read into.
inputStream	The stream to read from.

Exceptions:

.

---

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

• correlation/cfgextraction/V5CfgTileMap.hpp
• correlation/cfgextraction/V5CfgTileMap.cpp