The Simons     Component Library

           

---

MapID Class Reference

#include <MapID.h>

Inheritance diagram for MapID:

List of all members.

---

Detailed Description

MapID: a typed reference to a Map.

MapID is a strongly typed, reference counting pointer that refers to a Map. MapID variables may be initialised to Map* objects and all subtypes. MapID variables may alias objects held by other MapID variables, or any subtype. When a MapID acquires an object, it increments the object's reference count. When a MapID releases an object, it decrements the object's reference count. If the reference count reaches zero, the object is automatically deleted.

Public Member Functions
	MapID ()
	Declare a MapID.
	~MapID ()
	Release a MapID.
	MapID (const Null *)
	Initialise a MapID to refer explicitly to null.
	MapID (const Map *)
	Initialise a MapID to refer to a Map.
	MapID (const MapID &)
	Initialise a MapID to alias another MapID.
MapID &	operator= (const Map *)
	Reassign this MapID to refer to a Map.
MapID &	operator= (const MapID &)
	Reassign this MapID to alias another MapID.
Map *	operator-> () const
	Invoke a method on this MapID.

---

Constructor & Destructor Documentation

MapID::MapID (   )  [inline]

Declare a MapID. Returns: a null MapID.

MapID::~MapID (   )  [inline]

Release a MapID.

MapID::MapID (  const Null *  null  )  [inline]

Initialise a MapID to refer explicitly to null. Parameters: null  - the null reference. Returns: a MapID referring to null.

MapID::MapID (  const Map *  map  )  [inline]

Initialise a MapID to refer to a Map. Parameters: map  - the Map. Returns: a MapID referring to the map.

MapID::MapID (  const MapID &  pointer  )  [inline]

Initialise a MapID to alias another MapID. Parameters: pointer  - the other MapID. Returns: a MapID referring to the map.

---

Member Function Documentation

Map * MapID::operator-> (   )  const

Invoke a method on this MapID. Returns: the result of the method. Reimplemented from SetID.

MapID & MapID::operator= (  const MapID &  pointer  )  [inline]

Reassign this MapID to alias another MapID. Parameters: pointer  - the other MapID. Returns: an MapID referring to the same Map as the other MapID.

MapID & MapID::operator= (  const Map *  map  )  [inline]

Reassign this MapID to refer to a Map. Parameters: map  - the Map. Returns: a MapID referring to the map.

---

The documentation for this class was generated from the following files:

• MapID.h
• Map.cc
• Map.h

---