The Simons     Component Library

           

---

DeviceError Class Reference

#include <DeviceError.h>

Inheritance diagram for DeviceError:

List of all members.

---

Detailed Description

DeviceError: the abstract superclass of all device failures.

DeviceError is not raised directly, but classifies those exceptions that signal the failure of some device, either because it could not be found, or because it is not responding. Subclasses of DeviceError include NotFound and NoResponse. DeviceError captures common information about the device and its name.

Public Member Functions
	DeviceError ()
	Construct a default DeviceError.
virtual	~DeviceError ()
	Release a DeviceError.
	DeviceError (ObjectID, StringID, StringID)
	Construct a DeviceError reporting failure to interact with a device.
StringID	name () const
	Access the name of the failed device.
Protected Member Functions
	DeviceError (const DeviceError &)
	Copy another DeviceError.
Protected Attributes
StringID	deviceName
	The name of the failed device.

---

Constructor & Destructor Documentation

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

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

DeviceError::DeviceError (   )

Construct a default DeviceError. Returns: a DeviceError

DeviceError::~DeviceError (   )  [virtual]

Release a DeviceError.

DeviceError::DeviceError (  ObjectID  object, StringID  name, StringID  message )

Construct a DeviceError reporting failure to interact with a device. Used by subclasses to record common information about the failure. Parameters: object  - the object in which connection to a device failed. name  - the name of the failed device connection. message  - an error message String.

---

Member Function Documentation

StringID DeviceError::name (   )  const [inline]

Access the name of the failed device. Returns: the name of the failed device.

---

Member Data Documentation

StringID DeviceError::deviceName [protected]

The name of the failed device.

---

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

• DeviceError.h
• DeviceError.cc

---