The Simons     Component Library

           

---

OutOfRangeID Class Reference

#include <OutOfRangeID.h>

Inheritance diagram for OutOfRangeID:

List of all members.

---

Detailed Description

OutOfRangeID: a typed reference to an OutOfRange.

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

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

---

Constructor & Destructor Documentation

OutOfRangeID::OutOfRangeID (   )  [inline]

Declare an OutOfRangeID. Returns: a null OutOfRangeID.

OutOfRangeID::~OutOfRangeID (   )  [inline]

Release an OutOfRangeID.

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

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

OutOfRangeID::OutOfRangeID (  const OutOfRange *  exception  )  [inline]

Initialise an OutOfRangeID to refer to an OutOfRange. Parameters: exception  - the OutOfRange. Returns: an OutOfRangeID referring to the exception.

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

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

---

Member Function Documentation

OutOfRange * OutOfRangeID::operator-> (   )  const

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

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

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

OutOfRangeID & OutOfRangeID::operator= (  const OutOfRange *  exception  )  [inline]

Reassign this OutOfRangeID to refer to an OutOfRange. Parameters: exception  - the OutOfRange. Returns: an OutOfRangeID referring to the exception.

---

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

• OutOfRangeID.h
• OutOfRange.cc
• OutOfRange.h

---