University of Sheffield   

    The Simons
    Component Library

Introduction   Class Hierarchy   Class Listing   Index of Classes   Index of Methods   Header Files  

ReadFailure Class Reference

#include <ReadFailure.h>

Inheritance diagram for ReadFailure:

DataError Exception Object List of all members.

Detailed Description

ReadFailure: signals a failed attempt to read a datum.


Public Member Functions

 ReadFailure ()
 Construct a default ReadFailure.

virtual ~ReadFailure ()
 Release an ReadFailure.

 ReadFailure (StreamID, StringID, ObjectID)
 Construct an ReadFailure exception.

virtual ObjectID clone () const
 Clone a shallow copy of this ReadFailure.


Protected Member Functions

 ReadFailure (const ReadFailure &)
 Copy another ReadFailure.


Constructor & Destructor Documentation

ReadFailure::ReadFailure const ReadFailure &  exception  )  [protected]
 

Copy another ReadFailure.

Required by C++ to ensure that copying an ReadFailure faithfully copies a DataError.

Parameters:
exception - the ReadFailure to copy.
Returns:
an ReadFailure, a shallow copy.

ReadFailure::ReadFailure  ) 
 

Construct a default ReadFailure.

Returns:
an ReadFailure

ReadFailure::~ReadFailure  )  [virtual]
 

Release an ReadFailure.

ReadFailure::ReadFailure StreamID  stream,
StringID  method,
ObjectID  datum
 

Construct an ReadFailure exception.

Raised when an attempt is made to read a datum from a Stream. Records the datum (which may be a blank instance) and the name of the read-method which failed.

Parameters:
stream - the Stream on which reading failed.
method - the name of the failed method.
datum - an exemplar of the datum that was being read.
Returns:
a ReadFailure exception.


Member Function Documentation

ObjectID ReadFailure::clone  )  const [virtual]
 

Clone a shallow copy of this ReadFailure.

Returns:
a ReadFailure exception, a shallow copy.

Reimplemented from Exception.


The documentation for this class was generated from the following files:
Generated on Fri May 5 17:17:19 2006 for The Simons Component Library by doxygen1.3