The Simons     Component Library

           

---

DataError Class Reference

#include <DataError.h>

Inheritance diagram for DataError:

List of all members.

---

Detailed Description

DataError: the abstract superclass of failed data transfers.

DataError is not raised directly, but classifies those exceptions that signal the failure of some reading, writing or data transfer operation on a Stream. DataError captures common information about the failed Stream, the operation which failed and the datum that was being transferred.

Public Member Functions
	DataError ()
	Construct a default DataError.
virtual	~DataError ()
	Release a DataError.
	DataError (StreamID, StringID, ObjectID, StringID)
	Construct a DataError reporting failure to transfer a datum.
StringID	method () const
	Access the name of the failed method.
ObjectID	datum () const
	Access the datum being transferred.
Protected Member Functions
	DataError (const DataError &)
	Copy another DataError.
Protected Attributes
StringID	failedMethod
	The name of the failed method.
ObjectID	failedDatum
	The datum being transferred.

---

Constructor & Destructor Documentation

DataError::DataError (  const DataError &  exception  )  [protected]

Copy another DataError. Required by C++ to ensure that copying an DataError faithfully copies an Exception. Parameters: exception  - the DataError to copy. Returns: a DataError, a shallow copy.

DataError::DataError (   )

Construct a default DataError. Returns: a DataError

DataError::~DataError (   )  [virtual]

Release a DataError.

DataError::DataError (  StreamID  stream, StringID  method, ObjectID  datum, StringID  message )

Construct a DataError reporting failure to transfer a datum. Used by subclasses to record common information about the failure. Parameters: stream  - the Stream in which failure occurred. method  - the name of the method which failed. datum  - the datum that was being transferred. message  - an error message String.

---

Member Function Documentation

ObjectID DataError::datum (   )  const [inline]

Access the datum being transferred. Returns: the datum being transferred.

StringID DataError::method (   )  const [inline]

Access the name of the failed method. Returns: the name of a method.

---

Member Data Documentation

ObjectID DataError::failedDatum [protected]

The datum being transferred.

StringID DataError::failedMethod [protected]

The name of the failed method.

---

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

• DataError.h
• DataError.cc

---