The Simons     Component Library

           

---

ObjectError Class Reference

#include <ObjectError.h>

Inheritance diagram for ObjectError:

List of all members.

---

Detailed Description

ObjectError: the abstract superclass of Object failures.

ObjectError is not raised directly, but classifies those exceptions that signal a basic failure to obtain a valid object. Subclasses of ObjectError include NullPointer and TypeFailure. ObjectError captures common information about the failed Object and its expected Type.

Public Member Functions
	ObjectError ()
	Construct a default ObjectError.
virtual	~ObjectError ()
	Release an ObjectError.
	ObjectError (ObjectID, TypeID, StringID)
	Construct an ObjectError reporting failure in an Object.
TypeID	expectedType () const
	Access the expected Type.
Protected Member Functions
	ObjectError (const ObjectError &)
	Copy another ObjectError.
Protected Attributes
TypeID	desiredType
	The expected Type of the failed Object.

---

Constructor & Destructor Documentation

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

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

ObjectError::ObjectError (   )

Construct a default ObjectError. Returns: an ObjectError

ObjectError::~ObjectError (   )  [virtual]

Release an ObjectError.

ObjectError::ObjectError (  ObjectID  object, TypeID  type, StringID  message )

Construct an ObjectError reporting failure in an Object. Used by subclasses to record common information about the failure. Parameters: object  - the Object in which failure occurred. type  - the expected type of the failed Object. message  - an error message String.

---

Member Function Documentation

TypeID ObjectError::expectedType (   )  const [inline]

Access the expected Type. Returns: the expected Type.

---

Member Data Documentation

TypeID ObjectError::desiredType [protected]

The expected Type of the failed Object.

---

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

• ObjectError.h
• ObjectError.cc

---