The Simons     Component Library

           

---

UndefinedID Class Reference

#include <UndefinedID.h>

Inheritance diagram for UndefinedID:

List of all members.

---

Detailed Description

UndefinedID: a typed reference to an Undefined.

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

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

---

Constructor & Destructor Documentation

UndefinedID::UndefinedID (   )  [inline]

Declare an UndefinedID. Returns: a null UndefinedID.

UndefinedID::~UndefinedID (   )  [inline]

Release an UndefinedID.

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

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

UndefinedID::UndefinedID (  const Undefined *  exception  )  [inline]

Initialise an UndefinedID to refer to an Undefined. Parameters: exception  - the Undefined. Returns: an UndefinedID referring to the exception.

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

Initialise an UndefinedID to alias another UndefinedID. Parameters: pointer  - the other UndefinedID. Returns: an UndefinedID referring to the exception.

---

Member Function Documentation

Undefined * UndefinedID::operator-> (   )  const

Invoke a method on this UndefinedID. Returns: the result of the method. Reimplemented from MethodErrorID.

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

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

UndefinedID & UndefinedID::operator= (  const Undefined *  exception  )  [inline]

Reassign this UndefinedID to refer to an Undefined. Parameters: exception  - the Undefined. Returns: an UndefinedID referring to the exception.

---

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

• UndefinedID.h
• Undefined.cc
• Undefined.h

---