University of Sheffield   

    The Simons
    Component Library

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

WriteFailure Class Reference

#include <WriteFailure.h>

Inheritance diagram for WriteFailure:

DataError Exception Object List of all members.

Detailed Description

WriteFailure: signals a failed attempt to write a datum.


Public Member Functions

 WriteFailure ()
 Construct a default WriteFailure.

virtual ~WriteFailure ()
 Release an WriteFailure.

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

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


Protected Member Functions

 WriteFailure (const WriteFailure &)
 Copy another WriteFailure.


Constructor & Destructor Documentation

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

Copy another WriteFailure.

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

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

WriteFailure::WriteFailure  ) 
 

Construct a default WriteFailure.

Returns:
an WriteFailure

WriteFailure::~WriteFailure  )  [virtual]
 

Release an WriteFailure.

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

Construct an WriteFailure exception.

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

Parameters:
stream - the Stream on which writing failed.
method - the name of the failed method.
datum - an exemplar of the datum that was being written.
Returns:
a WriteFailure exception.


Member Function Documentation

ObjectID WriteFailure::clone  )  const [virtual]
 

Clone a shallow copy of this WriteFailure.

Returns:
a WriteFailure 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:20 2006 for The Simons Component Library by doxygen1.3