The Simons     Component Library

           

---

DeviceErrorID Class Reference

#include <DeviceErrorID.h>

Inheritance diagram for DeviceErrorID:

List of all members.

---

Detailed Description

DeviceErrorID: a typed reference to a DeviceError.

DeviceErrorID is a strongly typed, reference counting pointer that refers to a DeviceError. DeviceErrorID variables may be initialised to DeviceError* objects and all subtypes. DeviceErrorID variables may alias objects held by other DeviceErrorID variables, or any subtype. When a DeviceErrorID acquires an object, it increments the object's reference count. When a DeviceErrorID releases an object, it decrements the object's reference count. If the reference count reaches zero, the object is automatically deleted.

Public Member Functions
	DeviceErrorID ()
	Declare a DeviceErrorID.
	~DeviceErrorID ()
	Release a DeviceErrorID.
	DeviceErrorID (const Null *)
	Initialise a DeviceErrorID to refer explicitly to null.
	DeviceErrorID (const DeviceError *)
	Initialise a DeviceErrorID to refer to a DeviceError.
	DeviceErrorID (const DeviceErrorID &)
	Initialise a DeviceErrorID to alias another DeviceErrorID.
DeviceErrorID &	operator= (const DeviceError *)
	Reassign this DeviceErrorID to refer to a DeviceError.
DeviceErrorID &	operator= (const DeviceErrorID &)
	Reassign this DeviceErrorID to alias another DeviceErrorID.
DeviceError *	operator-> () const
	Invoke a method on this DeviceErrorID.

---

Constructor & Destructor Documentation

DeviceErrorID::DeviceErrorID (   )  [inline]

Declare a DeviceErrorID. Returns: a null DeviceErrorID.

DeviceErrorID::~DeviceErrorID (   )  [inline]

Release a DeviceErrorID.

DeviceErrorID::DeviceErrorID (  const Null *  null  )  [inline]

Initialise a DeviceErrorID to refer explicitly to null. Parameters: null  - the null reference. Returns: a DeviceErrorID referring to null.

DeviceErrorID::DeviceErrorID (  const DeviceError *  exception  )  [inline]

Initialise a DeviceErrorID to refer to a DeviceError. Parameters: exception  - the DeviceError. Returns: a DeviceErrorID referring to the exception.

DeviceErrorID::DeviceErrorID (  const DeviceErrorID &  pointer  )  [inline]

Initialise a DeviceErrorID to alias another DeviceErrorID. Parameters: pointer  - the other DeviceErrorID. Returns: a DeviceErrorID referring to the exception.

---

Member Function Documentation

DeviceError * DeviceErrorID::operator-> (   )  const

Invoke a method on this DeviceErrorID. Returns: the result of the method. Reimplemented from ExceptionID. Reimplemented in DeviceBusyID, NoResponseID, and NotFoundID.

DeviceErrorID & DeviceErrorID::operator= (  const DeviceErrorID &  pointer  )  [inline]

Reassign this DeviceErrorID to alias another DeviceErrorID. Parameters: pointer  - the other DeviceErrorID. Returns: a DeviceErrorID referring to the same DeviceError as the other DeviceErrorID.

DeviceErrorID & DeviceErrorID::operator= (  const DeviceError *  exception  )  [inline]

Reassign this DeviceErrorID to refer to a DeviceError. Parameters: exception  - the DeviceError. Returns: a DeviceErrorID referring to the exception.

---

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

• DeviceErrorID.h
• DeviceError.cc
• DeviceError.h

---