class CorMapPtrToPtr : public CorPersistent

A simple pointer to pointer map

Inheritance:

Public Methods

CorMapPtrToPtr ( int aSize = 10 )
CorMapPtrToPtr ( const CorMapPtrToPtr& aRef )
void deleteAssoc ( CorMapAssoc* aMapAssoc )
CorBool empty ()
unsigned int getHashTableSize ()
void getNextAssoc ( void*& aNewPosition, void* aKey, void* aValue )
void* getStartPosition ()
unsigned int hashKey ( void* aKey )
void initHashTable ( unsigned int aSize, CorBool allocNow = corTRUE )
CorBool lookUp ( void* aKey, void*& aValue )
virtual CorPersistent* makeClone ()
CorMapPtrToPtr& operator= ( const CorMapPtrToPtr& aRef )
void*& operator[] ( void* aKey )
void removeAll ()
CorBool removeKey ( void* aKey )
void setAt ( void* aKey, void* aValue )
unsigned int size ()
void stream ( CorStream& aFile )
virtual ~CorMapPtrToPtr ()

Public


Purpose
Query whether this map is empty

Purpose
Query the size of the hash table

Purpose
The d'tor

Purpose
Query the number of elements in the map

$Id: CorMapPtrToPtr

Purpose
Remove all the key value pairs

Purpose
Iterate all (key, value) pair

Protected Classes

struct CorMapAssoc
Purpose
Make a clone of this instance

Protected Methods

CorMapAssoc* getAssocAt ( void* aKey, unsigned int& aHash )
CorMapAssoc* newAssoc ()

Protected


Purpose
Create a new map association
struct CorMapAssoc
Purpose
Make a clone of this instance

Documentation

A simple pointer to pointer map
$Id: CorMapPtrToPtr.h,v 1.2 1997/04/11 13:31:58 mwiedmer Exp $

SYNOPSIS 

    #include <CorMapPtrToPtr.h>
  
    CorMapPtrToPtr myObject;

DESCRIPTION
This class represents a pointer to pointer map.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
CorPersistent

CorMapPtrToPtr( int aSize = 10 )

CorMapPtrToPtr( const CorMapPtrToPtr& aRef )

CorMapPtrToPtr& operator=( const CorMapPtrToPtr& aRef )

virtual ~CorMapPtrToPtr()

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 size()

Purpose
Query the number of elements in the map.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the number of elements.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

CorBool empty()

Purpose
Query whether this map is empty.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corTRUE if this map is empty.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

CorBool lookUp( void* aKey, void*& aValue )

void*& operator[]( void* aKey )

void setAt( void* aKey, void* aValue )

CorBool removeKey( void* aKey )

void removeAll()

Purpose
Remove all the key value pairs.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

void* getStartPosition()

Purpose
Iterate all (key, value) pair.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns something?

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

void getNextAssoc( void*& aNewPosition, void* aKey, void* aValue )

unsigned int getHashTableSize()

Purpose
Query the size of the hash table.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the current (full) size of the hash table.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

Arguments

void initHashTable( unsigned int aSize, CorBool allocNow = corTRUE )

unsigned int hashKey( void* aKey )

void stream( CorStream& aFile )

virtual CorPersistent* makeClone()

struct CorMapAssoc
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.

CorMapAssoc* newAssoc()

Purpose
Create a new map association.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a pointer to a new CorMapAssociation.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

void deleteAssoc( CorMapAssoc* aMapAssoc )

CorMapAssoc* getAssocAt( void* aKey, unsigned int& aHash )

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