The Simons     Component Library

           

---

MethodErrorID Class Reference

#include <MethodErrorID.h>

Inheritance diagram for MethodErrorID:

List of all members.

---

Detailed Description

MethodErrorID: a typed reference to a MethodError.

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

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

---

Constructor & Destructor Documentation

MethodErrorID::MethodErrorID (   )  [inline]

Declare an MethodErrorID. Returns: a null MethodErrorID.

MethodErrorID::~MethodErrorID (   )  [inline]

Release a MethodErrorID.

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

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

MethodErrorID::MethodErrorID (  const MethodError *  exception  )  [inline]

Initialise a MethodErrorID to refer to a MethodError. Parameters: exception  - the MethodError. Returns: a MethodErrorID referring to the exception.

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

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

---

Member Function Documentation

MethodError * MethodErrorID::operator-> (   )  const

Invoke a method on this MethodErrorID. Returns: the result of the method. Reimplemented from ExceptionID. Reimplemented in NoElementsID, OutOfRangeID, and UndefinedID.

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

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

MethodErrorID & MethodErrorID::operator= (  const MethodError *  exception  )  [inline]

Reassign this MethodErrorID to refer to a MethodError. Parameters: exception  - the MethodError. Returns: a MethodErrorID referring to the exception.

---

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

• MethodErrorID.h
• MethodError.cc
• MethodError.h

---