OpenArena::list< ItemType > Class Template Reference

Write brief comment for list here. More...

#include <list.h>

List of all members.

Public Member Functions
	list ()
	Write brief comment for list here.
	~list ()
	Write brief comment for ~list here.
	list (const list &)
	Write brief comment for list here.
bool	IsEmpty () const
	Write brief comment for IsEmpty here.
bool	IsFull () const
	Write brief comment for IsFull here.
void	Insert (ItemType newItem)
	Write brief comment for Insert here.
void	Remove (ItemType target)
	Write brief comment for Remove here.
void	Remove ()
	Write brief comment for Remove here.
ItemType	Retrieve () const
	Write brief comment for Retrieve here.
bool	PrevPosition ()
	Write brief comment for PrevPosition here.
bool	NextPosition ()
	Write brief comment for NextPosition here.
bool	IsFirstPosition () const
	Write brief comment for IsFirstPosition here.
bool	IsLastPosition () const
	Write brief comment for IsLastPosition here.
void	FirstPosition ()
	Write brief comment for FirstPosition here.
void	LastPosition ()
	Write brief comment for LastPosition here.
void	Clear ()
	Write brief comment for Clear here.
bool	Contains (ItemType) const
	Write brief comment for Contains here.
unsigned int	Length ()
	Write brief comment for Length here.
void	operator= (const list< ItemType > &)
	Write brief comment for operator = here.
ItemType	operator[] (LIST_ARRAY_INDEX_TYPE) const
	Write brief comment for operator [] here.
ItemType &	operator[] (LIST_ARRAY_INDEX_TYPE)
	Write brief comment for operator [] here.
Private Attributes
listNode< ItemType > *	head
listNode< ItemType > *	tail
listNode< ItemType > *	currPos

---

Detailed Description

template<class ItemType>
class OpenArena::list< ItemType >

Write brief comment for list here.

Parameters:

ItemType

Description of parameter ItemType.

Write detailed description for list here.

Remarks:

Write remarks for list here.

See also:

Separate items with the '|' character.

---

Constructor & Destructor Documentation

template<class ItemType>

OpenArena::list< ItemType >::list

(

)

Write brief comment for list here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for list here.

Remarks:

Write remarks for list here.

See also:

Separate items with the '|' character.

template<class ItemType>

OpenArena::list< ItemType >::~list

(

)

Write brief comment for ~list here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for ~list here.

Remarks:

Write remarks for ~list here.

See also:

Separate items with the '|' character.

template<class ItemType>

OpenArena::list< ItemType >::list

(

const list< ItemType > &

)

Write brief comment for list here.

Parameters:

Description

of parameter .

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for list here.

Remarks:

Write remarks for list here.

See also:

Separate items with the '|' character.

---

Member Function Documentation

template<class ItemType>

void OpenArena::list< ItemType >::Clear

(

)

Write brief comment for Clear here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Clear here.

Remarks:

Write remarks for Clear here.

See also:

Separate items with the '|' character.

template<class ItemType>

bool OpenArena::list< ItemType >::Contains

(

ItemType

)

const

Write brief comment for Contains here.

Parameters:

Description

of parameter .

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Contains here.

Remarks:

Write remarks for Contains here.

See also:

Separate items with the '|' character.

template<class ItemType>

void OpenArena::list< ItemType >::FirstPosition

(

)

Write brief comment for FirstPosition here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for FirstPosition here.

Remarks:

Write remarks for FirstPosition here.

See also:

Separate items with the '|' character.

template<class ItemType>

void OpenArena::list< ItemType >::Insert

(

ItemType

newItem

)

Write brief comment for Insert here.

Parameters:

newItem

Description of parameter newItem.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Insert here.

Remarks:

Write remarks for Insert here.

See also:

Separate items with the '|' character.

template<class ItemType>

bool OpenArena::list< ItemType >::IsEmpty

(

)

const

Write brief comment for IsEmpty here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for IsEmpty here.

Remarks:

Write remarks for IsEmpty here.

See also:

Separate items with the '|' character.

template<class ItemType>

bool OpenArena::list< ItemType >::IsFirstPosition

(

)

const

Write brief comment for IsFirstPosition here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for IsFirstPosition here.

Remarks:

Write remarks for IsFirstPosition here.

See also:

Separate items with the '|' character.

template<class ItemType>

bool OpenArena::list< ItemType >::IsFull

(

)

const

Write brief comment for IsFull here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for IsFull here.

Remarks:

Write remarks for IsFull here.

See also:

Separate items with the '|' character.

template<class ItemType>

bool OpenArena::list< ItemType >::IsLastPosition

(

)

const

Write brief comment for IsLastPosition here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for IsLastPosition here.

Remarks:

Write remarks for IsLastPosition here.

See also:

Separate items with the '|' character.

template<class ItemType>

void OpenArena::list< ItemType >::LastPosition

(

)

Write brief comment for LastPosition here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for LastPosition here.

Remarks:

Write remarks for LastPosition here.

See also:

Separate items with the '|' character.

template<class ItemType>

unsigned int OpenArena::list< ItemType >::Length

(

)

Write brief comment for Length here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Length here.

Remarks:

Write remarks for Length here.

See also:

Separate items with the '|' character.

template<class ItemType>

bool OpenArena::list< ItemType >::NextPosition

(

)

Write brief comment for NextPosition here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for NextPosition here.

Remarks:

Write remarks for NextPosition here.

See also:

Separate items with the '|' character.

template<class ItemType>

void OpenArena::list< ItemType >::operator=

(

const list< ItemType > &

)

Write brief comment for operator = here.

Parameters:

Description

of parameter .

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for operator = here.

Remarks:

Write remarks for operator = here.

See also:

Separate items with the '|' character.

template<class ItemType>

ItemType & OpenArena::list< ItemType >::operator[]

(

LIST_ARRAY_INDEX_TYPE

)

Write brief comment for operator [] here.

Parameters:

Description

of parameter .

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for operator [] here.

Remarks:

Write remarks for operator [] here.

See also:

Separate items with the '|' character.

template<class ItemType>

ItemType OpenArena::list< ItemType >::operator[]

(

LIST_ARRAY_INDEX_TYPE

)

const

Write brief comment for operator [] here.

Parameters:

Description

of parameter .

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for operator [] here.

Remarks:

Write remarks for operator [] here.

See also:

Separate items with the '|' character.

template<class ItemType>

bool OpenArena::list< ItemType >::PrevPosition

(

)

Write brief comment for PrevPosition here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for PrevPosition here.

Remarks:

Write remarks for PrevPosition here.

See also:

Separate items with the '|' character.

template<class ItemType>

void OpenArena::list< ItemType >::Remove

(

)

Write brief comment for Remove here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Remove here.

Remarks:

Write remarks for Remove here.

See also:

Separate items with the '|' character.

template<class ItemType>

void OpenArena::list< ItemType >::Remove

(

ItemType

target

)

Write brief comment for Remove here.

Parameters:

target

Description of parameter target.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Remove here.

Remarks:

Write remarks for Remove here.

See also:

Separate items with the '|' character.

template<class ItemType>

ItemType OpenArena::list< ItemType >::Retrieve

(

)

const

Write brief comment for Retrieve here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Retrieve here.

Remarks:

Write remarks for Retrieve here.

See also:

Separate items with the '|' character.

---

Member Data Documentation

template<class ItemType>

listNode<ItemType>* OpenArena::list< ItemType >::currPos [private]

template<class ItemType>

listNode<ItemType>* OpenArena::list< ItemType >::head [private]

template<class ItemType>

listNode<ItemType>* OpenArena::list< ItemType >::tail [private]

---

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

• src/list.h

---