#include <IList.hpp>

Inheritance diagram for zeus::IList< T >:

Public Member Functions
virtual Int MQUALIFIER	add (const T &rItem)=0
virtual Int MQUALIFIER	addAll (const IList< T > &rlstItems)=0
virtual Int MQUALIFIER	addEmptyItem ()=0
virtual void MQUALIFIER	copyToList (IList< T > &rList) const =0
virtual void MQUALIFIER	clear ()=0
virtual Retval MQUALIFIER	deleteItem (Int iIndex)=0
virtual Retval MQUALIFIER	remove (const T &rItem)=0
virtual Retval MQUALIFIER	removeAll (const IList< T > &rlstItems)=0
virtual Int MQUALIFIER	getCount () const =0
virtual T &MQUALIFIER	getItem (Int iIndex)=0
virtual const T &MQUALIFIER	getItemConst (Int iIndex) const =0
virtual Int MQUALIFIER	indexOf (const T &rItem) const =0
virtual Int MQUALIFIER	insert (Int iIndex, const T &rItem)=0
virtual bool MQUALIFIER	equalsItem (Int iIndex, const T &rItem) const =0
virtual bool MQUALIFIER	equals (const IList< T > &rList) const =0
virtual IListIterator< T > *MQUALIFIER	getIterator () const =0
virtual const IListIterator< T > *MQUALIFIER	getConstIterator () const =0
virtual void MQUALIFIER	releaseIterator (const IListIterator< T > *pIterator) const =0
virtual bool MQUALIFIER	isEmpty () const =0
virtual T &MQUALIFIER	getFirstItem ()=0
virtual const T &MQUALIFIER	getFirstItemConst () const =0
virtual T &MQUALIFIER	getLastItem ()=0
virtual const T &MQUALIFIER	getLastItemConst () const =0
virtual bool MQUALIFIER	hasItem (const T &rItem) const =0
virtual bool MQUALIFIER	hasAllItems (const IList< T > &rlstItems) const =0
Friends
class	TZVariant

Detailed Description

template<class T>
class zeus::IList< T >

Abstakter Datentyp Liste. Das Interface IStList beschreibt das Verhalten der Liste.

Member Function Documentation

template<class T>

virtual Int MQUALIFIER zeus::IList< T >::add ( const T & rItem ) [pure virtual]

Adds an element to the list.

Precondition:: no precondition

Postcondition:: newSize = oldSize + 1 and element rItem on the place [Length-1]
Before: e0, e1, e2 ... en
After: e0, e1, e2 ... en, rItem

Parameters:

rItem : Item to add

Returns:: Position of the added item

template<class T>

virtual Int MQUALIFIER zeus::IList< T >::addAll ( const IList< T > & rlstItems ) [pure virtual]

Adds a list of items to this list. The order is given by the iterator of the given list.

Parameters:

rlstItems : Item list to add

Returns:: Position of the last item added

template<class T>

virtual Int MQUALIFIER zeus::IList< T >::addEmptyItem ( ) [pure virtual]

Adds an empty item to the list

Returns:: Position of the last item added

template<class T>

virtual void MQUALIFIER zeus::IList< T >::clear ( ) [pure virtual]

Clears the list. All elements are removed from the list

Precondition:: no preconditions

Postcondition:: getSize() = 0

template<class T>

virtual void MQUALIFIER zeus::IList< T >::copyToList ( IList< T > & rList ) const [pure virtual]

This method assigns a new list of items to this list. The old list will be replaced

Parameters:

rList : list to assign

template<class T>

virtual Retval MQUALIFIER zeus::IList< T >::deleteItem ( Int iIndex ) [pure virtual]

Removes an element out of the list

Precondition:: iIndex >= 0 and iIndex < Size

Postcondition:: newSize = oldSize - 1 and the Element[iIndex] was before at the place lIndex + 1
Before: e0, e1, ... iIndex, iIndex+1 ... en
After: e0, e1, ... iIndex+1, iIndex+2 ... en

Parameters:

iIndex : Index of the element to remove

Return values:

RET_NOERROR	: Element removed
RET_REQUEST_FAILED,:	Could not remove element

template<class T>

virtual bool MQUALIFIER zeus::IList< T >::equals ( const IList< T > & rList ) const [pure virtual]

This method checks if two lists has the same content

Parameters:

rList : list to check

Return values:

true	: list is equal
false,:	list is not equal

template<class T>

virtual bool MQUALIFIER zeus::IList< T >::equalsItem	(	Int	iIndex,
		const T &	rItem
	)		const `[pure virtual]`

This method checks if an item is equal to an item inside this list

Parameters:

iIndex	: Index of the item to be checked
rItem	: Item to check

Return values:

true	: Item is equal
false,:	Item is not equal

template<class T>

virtual const IListIterator<T>* MQUALIFIER zeus::IList< T >::getConstIterator ( ) const [pure virtual]

Returns the const iterator of this list object. This iterator is used to traverse the list. The iterator will be allocated inside this method and must be released through the method releaseIterator(). Its possible to use the method as nested calls. The order of the releasing doesn't has to mach the getIterator() calls.

Returns:: pointer to a allocated iterator.

template<class T>

virtual Int MQUALIFIER zeus::IList< T >::getCount ( ) const [pure virtual]

Returns the number of items

Returns:: number of items

template<class T>

virtual T& MQUALIFIER zeus::IList< T >::getFirstItem ( ) [pure virtual]

returns the first item of the list

Returns:: first item

template<class T>

virtual const T& MQUALIFIER zeus::IList< T >::getFirstItemConst ( ) const [pure virtual]

returns the first item of the list. The return value is const.

See also:: IList::getFirstItem

template<class T>

virtual T& MQUALIFIER zeus::IList< T >::getItem ( Int iIndex ) [pure virtual]

Returns the indexed item at position iIndex

Precondition:: iIndex >= 0 und iIndex < Size

Postcondition:: no changes on the list

Parameters:

iIndex : Index of requested item

Return values:

Empty	element : Could not find the item at iIndex
Element[iIndex]	: item at [iIndex]

template<class T>

virtual const T& MQUALIFIER zeus::IList< T >::getItemConst ( Int iIndex ) const [pure virtual]

Returns the indexed item at position iIndex. The return value is const.

See also:: IList::getItem

template<class T>

virtual IListIterator<T>* MQUALIFIER zeus::IList< T >::getIterator ( ) const [pure virtual]

Returns the iterator of this list object. This iterator is used to traverse the list. The iterator will be allocated inside this method and must be released through the method releaseIterator(). Its possible to use the method as nested calls. The order of the releasing doesn't has to mach the getIterator() calls.

Returns:: pointer to a allocated iterator.

template<class T>

virtual T& MQUALIFIER zeus::IList< T >::getLastItem ( ) [pure virtual]

returns the last item of the list

Returns:: last item

template<class T>

virtual const T& MQUALIFIER zeus::IList< T >::getLastItemConst ( ) const [pure virtual]

returns the last item of the list. The return value is const.

See also:: IList::getLastItem

template<class T>

virtual bool MQUALIFIER zeus::IList< T >::hasAllItems ( const IList< T > & rlstItems ) const [pure virtual]

checks if the list contains all items of the given list

Parameters:

rlstItems,: list of items to check

Return values:

true	: all items are included by the list
false,:	at least one item is not not included by the list

template<class T>

virtual bool MQUALIFIER zeus::IList< T >::hasItem ( const T & rItem ) const [pure virtual]

checks if the list contains an item

Parameters:

rItem,: item to check

Return values:

true	: item is included by the list
false,:	item is not included by the list

template<class T>

virtual Int MQUALIFIER zeus::IList< T >::indexOf ( const T & rItem ) const [pure virtual]

returns the index of an item.

Parameters:

rItem : Item to check

Return values:

INVALID_INDEX	: Item is not inserted in this list
>=	0: Index of the item

template<class T>

virtual Int MQUALIFIER zeus::IList< T >::insert	(	Int	iIndex,
		const T &	rItem
	)		`[pure virtual]`

Inserts an item into the list at position iIndex.

Precondition:: iIndex must be valid (>= 0).

Postcondition:: if iIndex = 0, then the rItem is placed in the front (prepend); if the iIndex == count, the item is placed at the end (append); else the rItem is placed at position iIndex:

Parameters:

rItem	: Item to insert
iIndex	: insert position

Return values:

INVALID_INDEX	: Could not insert the element (invalid insert position)
>=	0: Item inserted. The return value is the insert position

template<class T>

virtual bool MQUALIFIER zeus::IList< T >::isEmpty ( ) const [pure virtual]

Checks if the list is empty

Return values:

true	: List is empty
false	: List is not empty

template<class T>

virtual void MQUALIFIER zeus::IList< T >::releaseIterator ( const IListIterator< T > * pIterator ) const [pure virtual]

This method releases a iterator object. This must be called after a call of getIterator(), otherwise it will cause a memory leak.

Parameters:

pIterator : Iterator to release.

template<class T>

virtual Retval MQUALIFIER zeus::IList< T >::remove ( const T & rItem ) [pure virtual]

Removes the element rItem out of the list.

Precondition:: no precondition

Postcondition:: see deleteItem()

Parameters:

rItem : Element to remove

Return values:

RET_NOERROR	: Element removed
RET_REQUEST_FAILED,:	Could not remove element

template<class T>

virtual Retval MQUALIFIER zeus::IList< T >::removeAll ( const IList< T > & rlstItems ) [pure virtual]

Removes all items of the given list.

Parameters:

rlstItems : Items to remove

Return values:

RET_NOERROR	: Items removed (at least one has been removed)
RET_REQUEST_FAILED,:	Could not remove any item

Friends And Related Function Documentation

template<class T>

friend class TZVariant [friend]

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

IList.hpp

zeus::IList< T > Class Template Reference

Public Member Functions

Friends

Detailed Description

template<class T> class zeus::IList< T >

Member Function Documentation

Friends And Related Function Documentation

template<class T>
class zeus::IList< T >