Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

skTVAList Template Class Reference

This class gives a value and array-based list. More...

#include <skValist.h>

Inheritance diagram for skTVAList:

skCompileErrorList skRValueArray skStringList List of all members.

Public Methods

 skTVAList ()
 Default Constructor - creates an empty list.

 skTVAList (const skTVAList<T>&)
 Copy Constructor - copies the contents of the other list into this one.

 skTVAList (USize initial_size,USize growth_increment)
 Constructor - taking initial size and growth increment for the list.

virtual ~skTVAList ()
 Destructor.

skTVAList& operator= (const skTVAList<T>&)
 Assignment operator - copies the contents of the other list.

void clear ()
 Clears this list.

USize entries () const
 Returns the number of entries in the list.

void deleteElt (USize n)
 deletes the nth item in the list. More...

void prepend (const T &t)
 Adds the given item to the start of the list.

void insert (const T &t,USize index)
 Inserts the given item *before* the specified index. More...

void append (const T &t)
 adds the given item to the list.

void remove (const T &t)
 removes the given item from the list.

T& operator[] (USize n) const
 retrieves the nth item from the list. More...

int index (const T &t) const
 returns the index of the item within the list. More...

bool contains (const T &t) const
 checks if the given item is in the list. More...

void growTo (USize new_size)
 instructs the list to grow to the given size (which must be greater than the current size). More...


Protected Methods

int findElt (const T &t) const
 returns the index of the given item in the list, or -1 if not found.

void grow ()
 grows the array that represents the list by the growth increment.


Protected Attributes

T* m_Array
 the array used to represent the list.

USize m_ArraySize
 the size of the array.

USize m_Entries
 the number of items being used in the list.

USize m_GrowthIncrement
 the amount to grow the array by.


Detailed Description

template<class T> template class skTVAList

This class gives a value and array-based list.


Member Function Documentation

template<class T>
TVALIST_PRE bool skTVAList< T >::contains ( const T & t ) const [inline]
 

checks if the given item is in the list.

Returns:
true if the list contains the item, otherwise false

template<class T>
TVALIST_PRE void skTVAList< T >::deleteElt ( USize n )
 

deletes the nth item in the list.

Exceptions:
skBoundsException   is thrown if the index is invalid

template<class T>
TVALIST_PRE void skTVAList< T >::growTo ( USize new_size )
 

instructs the list to grow to the given size (which must be greater than the current size).

The existing items are copied across

template<class T>
TVALIST_PRE int skTVAList< T >::index ( const T & t ) const [inline]
 

returns the index of the item within the list.

Returns:
the index, or -1 if not found

template<class T>
TVALIST_PRE void skTVAList< T >::insert ( const T & t,
USize index )
 

Inserts the given item *before* the specified index.

Exceptions:
skBoundsException   is thrown if the index is invalid

template<class T>
TVALIST_PRE T & skTVAList< T >::operator[] ( USize n ) const [inline]
 

retrieves the nth item from the list.

Exceptions:
skBoundsException   is thrown if the index is invalid
Returns:
a reference to the item


The documentation for this class was generated from the following file:
Generated at Mon May 14 08:43:08 2001 for Simkin by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000