The Simons     Component Library

           

---

ExceptionID Class Reference

#include <ExceptionID.h>

Inheritance diagram for ExceptionID:

List of all members.

---

Detailed Description

ExceptionID: a typed reference to an Exception.

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

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

---

Constructor & Destructor Documentation

ExceptionID::ExceptionID (   )  [inline]

Declare an ExceptionID. Returns: a null ExceptionID.

ExceptionID::~ExceptionID (   )  [inline]

Release an ExceptionID.

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

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

ExceptionID::ExceptionID (  const Exception *  exception  )  [inline]

Initialise an ExceptionID to refer to an Exception. Parameters: exception  - the Exception. Returns: an ExceptionID referring to the exception.

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

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

---

Member Function Documentation

Exception * ExceptionID::operator-> (   )  const

Invoke a method on this ExceptionID. Returns: the result of the method. Reimplemented from ObjectID. Reimplemented in DataErrorID, DeviceBusyID, DeviceErrorID, MethodErrorID, NoElementsID, NoResponseID, NotFoundID, NullPointerID, ObjectErrorID, OutOfRangeID, ReadFailureID, TypeFailureID, UndefinedID, and WriteFailureID.

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

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

ExceptionID & ExceptionID::operator= (  const Exception *  exception  )  [inline]

Reassign this ExceptionID to refer to an Exception. Parameters: exception  - the Exception. Returns: an ExceptionID referring to the exception.

---

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

• ExceptionID.h
• Exception.cc
• Exception.h

---