The Simons     Component Library

           

---

UnorderedID Class Reference

#include <UnorderedID.h>

Inheritance diagram for UnorderedID:

List of all members.

---

Detailed Description

UnorderedID: a typed reference to an Unordered collection.

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

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

---

Constructor & Destructor Documentation

UnorderedID::UnorderedID (   )  [inline]

Declare an UnorderedID. Returns: a null UnorderedID.

UnorderedID::~UnorderedID (   )  [inline]

Release an UnorderedID.

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

Initialise an UnorderedID to refer explicitly to null. Parameters: null  - the null reference. Returns: an UnorderedID referring to the unordered.

UnorderedID::UnorderedID (  const Unordered *  unordered  )  [inline]

Initialise an UnorderedID to refer to an Unordered. Parameters: unordered  - the Unordered. Returns: an UnorderedID referring to the unordered.

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

Initialise an UnorderedID to alias another UnorderedID. Parameters: pointer  - the other UnorderedID. Returns: an UnorderedID referring to the unordered.

---

Member Function Documentation

Unordered * UnorderedID::operator-> (   )  const

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

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

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

UnorderedID & UnorderedID::operator= (  const Unordered *  unordered  )  [inline]

Reassign this UnorderedID to refer to an Unordered. Parameters: unordered  - the Unordered. Returns: an UnorderedID referring to the unordered.

---

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

• UnorderedID.h
• Unordered.cc
• Unordered.h

---