NAME¶

UMap - maintains a mapping between two sets of pointers

SYNOPSIS¶

#include <Unidraw/umap.h>

DESCRIPTION¶

UMap is an abstract class for objects that store an arbitrary numberof pointer pairs and can search to find either member of a pair giventhe other. A UMapElem object stores each pointer pair in the UMap.UMapElem is an abstract class that defines virtuals for returningeither member of the pair, referred to as the id and the tag. Subclasses of UMapElem redefine these virtuals to return either member of the pair they store.

UMAPELEMPUBLICOPERATIONS¶

UMapElem()

The base class constructor does nothing by default.

virtual void* id()

virtual void* tag()

Return the id or the tag that the UMapElem stores. Subclassestypically define two member variables that store pair's valuesand redefine these operations to return them.

UMAPPUBLICOPERATIONS¶

virtual ~UMap()

The destructor deletes all UMapElem objects in the UMap.

int Count()

Return the number of mappings in the UMap, corresponding to the numberof UMapElems that have been registered.

void Clear()

Delete all the UMapElem mappings in the UMap without destroying the UMap.

UMAPPROTECTEDOPERATIONS¶

UMap()

The base class constructor does nothing by default.

void Register(UMapElem*)

void Unregister(UMapElem*)

Register or remove a UMapElem from the UMap.

int Index(UMapElem*)

UMapElem* Elem(int index)

A UMap stores its UMapElem in its _elems UArray protected member variable. The Index operations returns the index of the given UMapElem in the UArray, while Elem returns the UMapElem at a specified index. These operations simply perform the corresponding operations on the UArray.

virtual UMapElem* FindId(void* id)

virtual UMapElem* FindTag(void* tag)

FindId searches the UMap for the UMapElem element containing the givenid, while FindTag searches for the one with the given tag. Theseoperations perform linear searches by default, comparing theirarguments against the values that the UMapElems' id and tag operationsreturn. The comparison is based on the pointer values; subclasses canredefine these operations to make more sophisticated comparisons basedon the id or tags actual type. For example, if either the idis a string, then FindId might do a string comparison to detect a match.

SEEALSO¶

UArray(3U)