The Simons     Component Library

           

---

WriteFailureID Class Reference

#include <WriteFailureID.h>

Inheritance diagram for WriteFailureID:

List of all members.

---

Detailed Description

WriteFailureID: a typed reference to a WriteFailure.

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

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

---

Constructor & Destructor Documentation

WriteFailureID::WriteFailureID (   )  [inline]

Declare a WriteFailureID. Returns: a null WriteFailureID.

WriteFailureID::~WriteFailureID (   )  [inline]

Release a WriteFailureID.

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

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

WriteFailureID::WriteFailureID (  const WriteFailure *  exception  )  [inline]

Initialise a WriteFailureID to refer to a WriteFailure. Parameters: exception  - the WriteFailure. Returns: a WriteFailureID referring to the exception.

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

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

---

Member Function Documentation

WriteFailure * WriteFailureID::operator-> (   )  const

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

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

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

WriteFailureID & WriteFailureID::operator= (  const WriteFailure *  exception  )  [inline]

Reassign this WriteFailureID to refer to a WriteFailure. Parameters: exception  - the WriteFailure. Returns: a WriteFailureID referring to the exception.

---

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

• WriteFailureID.h
• WriteFailure.cc
• WriteFailure.h

---