BrailleTutorNS::BTException Struct Reference

An exception class for reporting errors and failure conditions. More...

#include <Types.h>

List of all members.

Public Types

enum  Type {
  BT_EMISC, BT_EINVAL, BT_EDOM, BT_ENOENT,
  BT_EBUSY, BT_EACCES, BT_EIO, BT_ETIMEDOUT,
  BT_EALREADY, BT_EUNKNOWN
}
 Braille Tutor library error type symbols. More...

Public Member Functions

 BTException ()
 Constructor without arguments.
 BTException (const Type &my_type, const std::string &my_why="")
 Constructor allowing specification of error type and extra information.

Public Attributes

Type type
 Error type.
std::string why
 Optional string with additional error information.


Detailed Description

An exception class for reporting errors and failure conditions.

Member Enumeration Documentation

enum BrailleTutorNS::BTException::Type

Braille Tutor library error type symbols.

Symbols indicating what type of error is indicated by this exception. Symbol interpretations generally match their POSIX counterparts (see errno(3) on Linux or intro(2) on MacOS X).

Enumerator:
BT_EMISC  Miscellaneous error---usually critical.
BT_EINVAL  Invalid argument.
BT_EDOM  Numerical argument out of function domain.
BT_ENOENT  File or resource does not exist.
BT_EBUSY  File or resource busy/in use.
BT_EACCES  File or resource has access restrictions.
BT_EIO  I/O error.
BT_ETIMEDOUT  Operation timeout.
BT_EALREADY  Operation already completed.
BT_EUNKNOWN  Unspecified error (should not use).


The documentation for this struct was generated from the following file:
Generated on Fri Nov 16 14:50:27 2007 for Braille Tutor Interface Library by  doxygen 1.5.3