The Simons     Component Library

           

---

ReadFailureID Class Reference

#include <ReadFailureID.h>

Inheritance diagram for ReadFailureID:

List of all members.

---

Detailed Description

ReadFailureID: a typed reference to a ReadFailure.

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

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

---

Constructor & Destructor Documentation

ReadFailureID::ReadFailureID (   )  [inline]

Declare a ReadFailureID. Returns: a null ReadFailureID.

ReadFailureID::~ReadFailureID (   )  [inline]

Release a ReadFailureID.

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

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

ReadFailureID::ReadFailureID (  const ReadFailure *  exception  )  [inline]

Initialise a ReadFailureID to refer to a ReadFailure. Parameters: exception  - the ReadFailure. Returns: a ReadFailureID referring to the exception.

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

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

---

Member Function Documentation

ReadFailure * ReadFailureID::operator-> (   )  const

Invoke a method on this ReadFailureID. Returns: the result of the method. Reimplemented from DataErrorID.

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

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

ReadFailureID & ReadFailureID::operator= (  const ReadFailure *  exception  )  [inline]

Reassign this ReadFailureID to refer to a ReadFailure. Parameters: exception  - the ReadFailure. Returns: a ReadFailureID referring to the exception.

---

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

• ReadFailureID.h
• ReadFailure.cc
• ReadFailure.h

---