Arak::Grid< ItemType >::Cell::Entry Class Reference

#include <grid.hpp>

Collaboration diagram for Arak::Grid< ItemType >::Cell::Entry:

[legend]List of all members.

---

Detailed Description

template<class ItemType>
class Arak::Grid< ItemType >::Cell::Entry

This is a object which permits the efficient removal of an item from a cell's list of items.

Definition at line 107 of file grid.hpp.

Public Member Functions
	Entry ()
	Constructor.
	Entry (Cell *cell, ItemIterator it)
	Constructor.
bool	valid () const
	Tests to see if this entry is still valid.
void	remove ()
	Removes the item stored in this entry from the internal list of items associated with this cell.
const Cell &	getCell () const
	Returns the cell in which this entry resides.
Private Attributes
Cell *	cell
	The cell in which the entry resides.
ItemIterator	it
	An iterator that points to the item.

---

Constructor & Destructor Documentation

template<class ItemType> Arak::Grid< ItemType >::Cell::Entry::Entry (   )  [inline]

Constructor. Definition at line 126 of file grid.hpp. References Arak::Grid< ItemType >::Cell::Entry::cell.

template<class ItemType> Arak::Grid< ItemType >::Cell::Entry::Entry (  Cell *  cell, ItemIterator  it )  [inline]

Constructor. Definition at line 131 of file grid.hpp. References Arak::Grid< ItemType >::Cell::ItemIterator.

---

Member Function Documentation

template<class ItemType> const Cell& Arak::Grid< ItemType >::Cell::Entry::getCell (   )  const [inline]

Returns the cell in which this entry resides. Definition at line 153 of file grid.hpp. References Arak::Grid< ItemType >::Cell::Entry::cell.

template<class ItemType> void Arak::Grid< ItemType >::Cell::Entry::remove (   )  [inline]

Removes the item stored in this entry from the internal list of items associated with this cell. This entry becomes invalid after this operation. Definition at line 143 of file grid.hpp. References Arak::Grid< ItemType >::Cell::Entry::cell, Arak::Grid< ItemType >::Cell::items, Arak::Grid< ItemType >::Cell::unused, and Arak::Grid< ItemType >::Cell::Entry::valid().

template<class ItemType> bool Arak::Grid< ItemType >::Cell::Entry::valid (   )  const [inline]

Tests to see if this entry is still valid. Definition at line 136 of file grid.hpp. References Arak::Grid< ItemType >::Cell::Entry::cell. Referenced by Arak::Grid< ItemType >::Cell::Entry::remove().

---

Member Data Documentation

template<class ItemType> Cell* Arak::Grid< ItemType >::Cell::Entry::cell [private]

The cell in which the entry resides. Definition at line 114 of file grid.hpp. Referenced by Arak::Grid< ItemType >::Cell::Entry::Entry(), Arak::Grid< ItemType >::Cell::Entry::getCell(), Arak::Grid< ItemType >::Cell::Entry::remove(), and Arak::Grid< ItemType >::Cell::Entry::valid().

template<class ItemType> ItemIterator Arak::Grid< ItemType >::Cell::Entry::it [private]

An iterator that points to the item. Definition at line 119 of file grid.hpp.

---

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

• grid.hpp

---