The Simons     Component Library

           

---

ObjectErrorID Class Reference

#include <ObjectErrorID.h>

Inheritance diagram for ObjectErrorID:

List of all members.

---

Detailed Description

ObjectErrorID: a typed reference to an ObjectError.

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

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

---

Constructor & Destructor Documentation

ObjectErrorID::ObjectErrorID (   )  [inline]

Declare an ObjectErrorID. Returns: a null ObjectErrorID.

ObjectErrorID::~ObjectErrorID (   )  [inline]

Release an ObjectErrorID.

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

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

ObjectErrorID::ObjectErrorID (  const ObjectError *  exception  )  [inline]

Initialise an ObjectErrorID to refer to an ObjectError. Parameters: exception  - the ObjectError. Returns: an ObjectErrorID referring to the exception.

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

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

---

Member Function Documentation

ObjectError * ObjectErrorID::operator-> (   )  const

Invoke a method on this ObjectErrorID. Returns: the result of the method. Reimplemented from ExceptionID. Reimplemented in NullPointerID, and TypeFailureID.

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

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

ObjectErrorID & ObjectErrorID::operator= (  const ObjectError *  exception  )  [inline]

Reassign this ObjectErrorID to refer to an ObjectError. Parameters: exception  - the ObjectError. Returns: an ObjectErrorID referring to the exception.

---

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

• ObjectErrorID.h
• ObjectError.cc
• ObjectError.h

---