The Simons     Component Library

           

---

NullPointerID Class Reference

#include <NullPointerID.h>

Inheritance diagram for NullPointerID:

List of all members.

---

Detailed Description

NullPointerID: a typed reference to a NullPointer.

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

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

---

Constructor & Destructor Documentation

NullPointerID::NullPointerID (   )  [inline]

Declare a NullPointerID. Returns: a null NullPointerID.

NullPointerID::~NullPointerID (   )  [inline]

Release a NullPointerID.

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

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

NullPointerID::NullPointerID (  const NullPointer *  exception  )  [inline]

Initialise a NullPointerID to refer to a NullPointer. Parameters: exception  - the NullPointer. Returns: a NullPointerID referring to the exception.

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

Initialise a NullPointerID to alias another NullPointerID. Parameters: pointer  - the other NullPointerID. Returns: a NullPointerID referring to the exception.

---

Member Function Documentation

NullPointer * NullPointerID::operator-> (   )  const

Invoke a method on this NullPointerID. Returns: the result of the method. Reimplemented from ObjectErrorID.

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

Reassign this NullPointerID to alias another NullPointerID. Parameters: pointer  - the other NullPointerID. Returns: a NullPointerID referring to the same NullPointer as the other NullPointerID.

NullPointerID & NullPointerID::operator= (  const NullPointer *  exception  )  [inline]

Reassign this NullPointerID to refer to a NullPointer. Parameters: exception  - the NullPointer. Returns: a NullPointerID referring to the exception.

---

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

• NullPointerID.h
• NullPointer.cc
• NullPointer.h

---