Exception Class Reference

Represents base class of all exceptions. More...

#include <exception.h>

Inheritance diagram for Exception:

[legend]

List of all members.

Public Member Functions
	Exception (EXCEPTION_TYPE _type, const char *_error_msg, ERROR_ID _error_id=eid_notset, EXCEPTION_LEVEL _exception_level=excl_fatal)
	Constructor.
virtual	~Exception ()
void	terminate (int exit_code=EXIT_FAILURE)
	Terminates the application immediately.
const char *	getDebugMsg ()
	Returns the error message of the corresponding exception.
const EXCEPTION_TYPE	getType ()
	Returns the EXCEPTION_TYPE of the corresponding exception.
const char *	getErrorMsg ()
	Returns the error message of the corresponding exception.
ERROR_ID	getErrorId ()
	Returns the ERROR_ID of the corresponding exception.
const EXCEPTION_LEVEL	getExceptionLevel ()
	Returns the EXCEPTION_LEVEL of the corresponding exception.
Protected Attributes
EXCEPTION_TYPE	type
	The entered EXCEPTION_TYPE.
const char *	error_msg
	The entered string (as error message).
ERROR_ID	error_id
	The entered ERROR_ID.
EXCEPTION_LEVEL	exception_level
	The entered EXCEPTION_LEVEL.

---

Detailed Description

Represents base class of all exceptions.

Represents base class of all exceptions.

Author:

Michael Schmidt

Gunnar Jehl

Version:

2.1

License:

Software License Agreement (BSD License)

Definition at line 54 of file exception.h.

---

Constructor & Destructor Documentation

Exception::Exception	(	EXCEPTION_TYPE	_type,
		const char *	_error_msg,
		ERROR_ID	_error_id = eid_notset,
		EXCEPTION_LEVEL	_exception_level = excl_fatal
	)

Constructor.

Constructor - creating object for an EXCEPTION_TYPE, a string (as error message), an ERROR_ID and an EXCEPTION_LEVEL.

Parameters:

[in]	_type	EXCEPTION_TYPE.
[in]	_error_msg	Pointer to a char object.
[in]	_error_id	ERROR_ID.
[in]	_exception_level	EXCEPTION_LEVEL.

Definition at line 37 of file exception.cpp.

Exception::~Exception

(

)

[virtual]

Destructor.

Definition at line 45 of file exception.cpp.

References error_msg.

---

Member Function Documentation

const char * Exception::getDebugMsg

(

)

Returns the error message of the corresponding exception.

Returns the error message of the corresponding exception.

Return values:

const

char* Pointer to a char object.

Definition at line 53 of file exception.cpp.

References error_id, error_msg, exception_level, and type.

Referenced by main(), and Executor::start().

ERROR_ID Exception::getErrorId

(

)

[inline]

Returns the ERROR_ID of the corresponding exception.

Returns the ERROR_ID of the corresponding exception.

Return values:

ERROR_ID.

Definition at line 110 of file exception.h.

References error_id.

const char * Exception::getErrorMsg

(

)

[inline]

Returns the error message of the corresponding exception.

Returns the error message of the corresponding exception.

Return values:

const

char* Pointer to a char object.

Definition at line 101 of file exception.h.

const EXCEPTION_LEVEL Exception::getExceptionLevel

(

)

[inline]

Returns the EXCEPTION_LEVEL of the corresponding exception.

Returns the EXCEPTION_LEVEL of the corresponding exception.

Return values:

const

EXCEPTION_LEVEL.

Definition at line 119 of file exception.h.

References exception_level.

const EXCEPTION_TYPE Exception::getType

(

)

[inline]

Returns the EXCEPTION_TYPE of the corresponding exception.

Returns the EXCEPTION_TYPE of the corresponding exception.

Return values:

EXCEPTION_TYPE.

Definition at line 94 of file exception.h.

References type.

void Exception::terminate

(

int

exit_code = EXIT_FAILURE

)

Terminates the application immediately.

Terminates the application immediately, returning the entered parameter to the operating system.

Parameters:

[in]

exit_code

Returned parameter to the operating system.

Return values:

void

Definition at line 49 of file exception.cpp.

Referenced by Executor::start().

---

Member Data Documentation

ERROR_ID Exception::error_id [protected]

The entered ERROR_ID.

The entered ERROR_ID, which is the third argument of the constructor.

Definition at line 140 of file exception.h.

Referenced by getDebugMsg(), and getErrorId().

const char * Exception::error_msg [protected]

The entered string (as error message).

The entered string (as error message), which is the second argument of the constructor.

Definition at line 134 of file exception.h.

Referenced by getDebugMsg(), and ~Exception().

EXCEPTION_LEVEL Exception::exception_level [protected]

The entered EXCEPTION_LEVEL.

The entered EXCEPTION_LEVEL, which is the fourth argument of the constructor.

Definition at line 146 of file exception.h.

Referenced by getDebugMsg(), and getExceptionLevel().

EXCEPTION_TYPE Exception::type [protected]

The entered EXCEPTION_TYPE.

The entered EXCEPTION_TYPE, which is the first argument of the constructor.

Definition at line 128 of file exception.h.

Referenced by getDebugMsg(), and getType().