class Map

Defined in: C4Map.h

The Map class encapsulates an associative key-value map.

Definition

template <class type> class Map : public MapBase

Member Functions

`Map::First`	Returns the first element in a map.
`Map::Last`	Returns the last element in a map.
`Map::Member`	Returns a boolean value indicating whether a particular object is a member of a map.
`Map::Empty`	Returns a boolean value indicating whether a map is empty.
`Map::GetElementCount`	Returns the number of elements in a map.
`Map::Insert`	Adds an object to a map.
`Map::InsertReplace`	Adds an object to a map and replaces an existing object having the same key.
`Map::Remove`	Removes a particular element from a map.
`Map::RemoveAll`	Removes all elements from a map.
`Map::Purge`	Deletes all elements in a map.
`Map::Find`	Finds an object in a map.

Template Parameters

type The type of the class that can be stored in the map. The class specified by this parameter should inherit directly from the MapElement class using the same template parameter.

Constructor

Map();

Description

The Map class template is a container used to store an associative key-value map of objects. The class type of objects that are to be stored in the map must be a subclass of the MapElement class template using the same template parameters as the Map container. A particular object can be a member of only one map at a time.

Upon construction, a Map object is empty. When a Map object is destroyed, all of the members of the map are also destroyed. To avoid deleting the members of a map when a Map object is destroyed, first call the Map::RemoveAll function to remove all of the map's members.

The class specified by the type template parameter must define a type named KeyType and a function named GetKey that has one of the following two prototypes.

KeyType GetKey(void) const;

const KeyType& GetKey(void) const;

Overloaded Operators

type *operator [](long index) const; Returns the element of a map whose zero-based index is index. If index is greater than or equal to the number of elements in the list, then the return value is nullptr.

Base Classes

MapBase Used internally to encapsulate common functionality that is independent of the template parameters.