The Simons     Component Library

           

---

TypeFailureID Class Reference

#include <TypeFailureID.h>

Inheritance diagram for TypeFailureID:

List of all members.

---

Detailed Description

TypeFailureID: a typed reference to a TypeFailure.

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

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

---

Constructor & Destructor Documentation

TypeFailureID::TypeFailureID (   )  [inline]

Declare a TypeFailureID. Returns: a null TypeFailureID.

TypeFailureID::~TypeFailureID (   )  [inline]

Release a TypeFailureID.

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

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

TypeFailureID::TypeFailureID (  const TypeFailure *  exception  )  [inline]

Initialise a TypeFailureID to refer to a TypeFailure. Parameters: exception  - the TypeFailure. Returns: a TypeFailureID referring to the exception.

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

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

---

Member Function Documentation

TypeFailure * TypeFailureID::operator-> (   )  const

Invoke a method on this TypeFailureID. Returns: the result of the method. Reimplemented from ObjectErrorID.

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

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

TypeFailureID & TypeFailureID::operator= (  const TypeFailure *  exception  )  [inline]

Reassign this TypeFailureID to refer to a TypeFailure. Parameters: exception  - the TypeFailure. Returns: a TypeFailureID referring to the exception.

---

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

• TypeFailureID.h
• TypeFailure.cc
• TypeFailure.h

---