The Simons     Component Library

           

---

DataErrorID Class Reference

#include <DataErrorID.h>

Inheritance diagram for DataErrorID:

List of all members.

---

Detailed Description

DataErrorID: a typed reference to a DataError.

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

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

---

Constructor & Destructor Documentation

DataErrorID::DataErrorID (   )  [inline]

Declare a DataErrorID. Returns: a null DataErrorID.

DataErrorID::~DataErrorID (   )  [inline]

Release a DataErrorID.

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

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

DataErrorID::DataErrorID (  const DataError *  exception  )  [inline]

Initialise a DataErrorID to refer to a DataError. Parameters: exception  - the DataError. Returns: a DataErrorID referring to the exception.

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

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

---

Member Function Documentation

DataError * DataErrorID::operator-> (   )  const

Invoke a method on this DataErrorID. Returns: the result of the method. Reimplemented from ExceptionID. Reimplemented in ReadFailureID, and WriteFailureID.

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

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

DataErrorID & DataErrorID::operator= (  const DataError *  exception  )  [inline]

Reassign this DataErrorID to refer to a DataError. Parameters: exception  - the DataError. Returns: a DataErrorID referring to the exception.

---

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

• DataErrorID.h
• DataError.cc
• DataError.h

---