class CorPtrArray : public CorPersistent

A array of pointers

Inheritance:

Public Methods

unsigned int	add ( void* anElement )
	CorPtrArray ( const CorPtrArray& aRef )
	CorPtrArray ()
void*&	elementAt ( unsigned int aPosition )
void	freeExtra ()
void*	getAt ( unsigned int aPosition )
unsigned int	getSize ()
unsigned int	getUpperBound ()
void	insertAt ( unsigned int aPostion, CorPtrArray* anArray )
void	insertAt ( unsigned int aPosition, void* anElement, unsigned int aCount = 1 )
virtual CorPersistent*	makeClone ()
CorPtrArray&	operator= ( const CorPtrArray& aRef )
void*&	operator[] ( unsigned int aPosition )
void*	operator[] ( unsigned int aPosition )
void	removeAll ()
void	removeAt ( unsigned int aPosition, unsigned int aCount = 1 )
void	setAt ( unsigned int aPosition, void* anElement )
void	setAtGrow ( unsigned int aPosition, void* anElement )
void	setSize ( unsigned int aNewSize, int aGrwothRate = -1 )
virtual void	stream (CorStream& aFile) Purpose Make a clone of this instance
virtual	~CorPtrArray ()

Public

	Purpose Query the upper bound of this array (next free position)
	Purpose Clean up the array
	Purpose The default c'tor
	Purpose The d'tor
	$Id: CorPtrArray
	Purpose Query the size of the array
	Purpose Clear extra memory

$Id: CorPtrArray.h,v 1.2 1997/04/11 13:32:00 mwiedmer Exp $

SYNOPSIS

    #include <CorPtrArray.h>
  
    CorPtrArray myObject;
  

DESCRIPTION
This text serves as an example for the documentation of a class definition

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
<optional>
CorBase

CorPtrArray()

Purpose
The default c'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

CorPtrArray( const CorPtrArray& aRef )

CorPtrArray& operator=( const CorPtrArray& aRef )

virtual ~CorPtrArray()

Purpose
The d'tor. If it's not in a hierarchy it probably doesn't want to be virtual.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

unsigned int getUpperBound()

Purpose
Query the upper bound of this array (next free position).

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the position of the next available slot.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

unsigned int getSize()

Purpose
Query the size of the array.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the nuber of elements in the array.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void setSize( unsigned int aNewSize, int aGrwothRate = -1 )

void freeExtra()

Purpose
Clear extra memory.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void removeAll()

Purpose
Clean up the array.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void* getAt( unsigned int aPosition )

void setAt( unsigned int aPosition, void* anElement )

void*& elementAt( unsigned int aPosition )

void setAtGrow( unsigned int aPosition, void* anElement )

unsigned int add( void* anElement )

void* operator[]( unsigned int aPosition )

void*& operator[]( unsigned int aPosition )

void insertAt( unsigned int aPosition, void* anElement, unsigned int aCount = 1 )

void removeAt( unsigned int aPosition, unsigned int aCount = 1 )

void insertAt( unsigned int aPostion, CorPtrArray* anArray )

virtual CorPersistent* makeClone()

virtual void stream(CorStream& aFile)

Purpose
Make a clone of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function retutns a pointer to a newly created instance that has the same properties as this one.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

This class has no child classes.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de