The Simons     Component Library

           

---

NotFoundID Class Reference

#include <NotFoundID.h>

Inheritance diagram for NotFoundID:

List of all members.

---

Detailed Description

NotFoundID: a typed reference to a NotFound.

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

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

---

Constructor & Destructor Documentation

NotFoundID::NotFoundID (   )  [inline]

Declare a NotFoundID. Returns: a null NotFoundID.

NotFoundID::~NotFoundID (   )  [inline]

Release a NotFoundID.

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

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

NotFoundID::NotFoundID (  const NotFound *  exception  )  [inline]

Initialise a NotFoundID to refer to a NotFound. Parameters: exception  - the NotFound. Returns: a NotFoundID referring to the exception.

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

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

---

Member Function Documentation

NotFound * NotFoundID::operator-> (   )  const

Invoke a method on this NotFoundID. Returns: the result of the method. Reimplemented from DeviceErrorID.

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

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

NotFoundID & NotFoundID::operator= (  const NotFound *  exception  )  [inline]

Reassign this NotFoundID to refer to a NotFound. Parameters: exception  - the NotFound. Returns: a NotFoundID referring to the exception.

---

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

• NotFoundID.h
• NotFound.cc
• NotFound.h

---