The Simons     Component Library

           

---

CollectionID Class Reference

#include <CollectionID.h>

Inheritance diagram for CollectionID:

List of all members.

---

Detailed Description

CollectionID: a typed reference to a Collection.

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

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

---

Constructor & Destructor Documentation

CollectionID::CollectionID (   )  [inline]

Declare a CollectionID. Returns: a null CollectionID.

CollectionID::~CollectionID (   )  [inline]

Release a CollectionID.

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

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

CollectionID::CollectionID (  const Collection *  collection  )  [inline]

Initialise a CollectionID to refer to a Collection. Parameters: collection  - the Collection. Returns: a CollectionID referring to the collection.

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

Initialise a CollectionID to alias another CollectionID. Parameters: pointer  - the other CollectionID. Returns: a CollectionID referring to the collection.

---

Member Function Documentation

Collection * CollectionID::operator-> (   )  const

Invoke a method on this CollectionID. Returns: the result of the method. Reimplemented from ObjectID. Reimplemented in BagID, ListID, MapID, RelationID, SequenceID, SetID, StringID, UnorderedID, and VectorID.

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

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

CollectionID & CollectionID::operator= (  const Collection *  collection  )  [inline]

Reassign this CollectionID to refer to a Collection. Parameters: collection  - the Collection. Returns: a CollectionID referring to the collection.

---

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

• CollectionID.h
• Collection.cc
• Collection.h

---