Tutorial Class/Enum List File List Compound Members

KDjError Class Reference

Exception handling class for KDjKernel and KDjExtended base classes. More...

#include <KontrolDj.h>

List of all members.

Public Types

enum Type {
  WARNING, UNSPECIFIED, NO_DEVICES_FOUND, INVALID_DEVICE,
  INVALID_PARAMETER, DRIVER_ERROR, NOT_SYNCH, TX_FAIL,
  RX_FAIL
}

Defined KDjError types. More...

Public Member Functions

KDjError (const std::string &message, Type type=KDjError::UNSPECIFIED)

The constructor.

virtual ~KDjError (void)

The destructor.

virtual void printMessage (void)

Prints "thrown" error message to stdout.

virtual const Type & getType (void)

Returns the "thrown" error message type.

virtual const std::string & getMessage (void)

Returns the "thrown" error message string.

Protected Attributes

std::string message_

Type type_

Detailed Description

Exception handling class for KDjKernel and KDjExtended base classes.

The KDjError class is quite simple but it does allow errors to be "caught" by KDjError::Type. See the KDjKernel and KDjExtended documentation to know which methods can "throw" an KDjError.

Definition at line 67 of file KontrolDj.h.

Member Enumeration Documentation

enum KDjError::Type

Defined KDjError types.

Enumeration values:

WARNING

UNSPECIFIED

NO_DEVICES_FOUND

INVALID_DEVICE

INVALID_PARAMETER

DRIVER_ERROR

NOT_SYNCH

TX_FAIL

RX_FAIL

Definition at line 72 of file KontrolDj.h.

Constructor & Destructor Documentation

KDjError::KDjError ( const std::string & message,

Type type = KDjError::UNSPECIFIED

) [inline]

The constructor.

Definition at line 92 of file KontrolDj.h.

virtual KDjError::~KDjError ( void ) [inline, virtual]

The destructor.

Definition at line 95 of file KontrolDj.h.

Member Function Documentation

virtual void KDjError::printMessage ( void ) [inline, virtual]

Prints "thrown" error message to stdout.

Definition at line 98 of file KontrolDj.h.

virtual const Type& KDjError::getType ( void ) [inline, virtual]

Returns the "thrown" error message type.

Definition at line 101 of file KontrolDj.h.

virtual const std::string& KDjError::getMessage ( void ) [inline, virtual]

Returns the "thrown" error message string.

Definition at line 104 of file KontrolDj.h.

Member Data Documentation

std::string KDjError::message_ [protected]

Definition at line 86 of file KontrolDj.h.

Type KDjError::type_ [protected]

Definition at line 87 of file KontrolDj.h.

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

KontrolDj.h


Public Types
enum	Type { WARNING, UNSPECIFIED, NO_DEVICES_FOUND, INVALID_DEVICE, INVALID_PARAMETER, DRIVER_ERROR, NOT_SYNCH, TX_FAIL, RX_FAIL }
	Defined KDjError types. More...
Public Member Functions
	KDjError (const std::string &message, Type type=KDjError::UNSPECIFIED)
	The constructor.
virtual	~KDjError (void)
	The destructor.
virtual void	printMessage (void)
	Prints "thrown" error message to stdout.
virtual const Type &	getType (void)
	Returns the "thrown" error message type.
virtual const std::string &	getMessage (void)
	Returns the "thrown" error message string.
Protected Attributes
std::string	message_
Type	type_