ParCompMark::Exception Class Reference

#include <PCMException.h>

Collaboration diagram for ParCompMark::Exception:

Detailed Description

: Provides information about an internal error.

Remarks:: An application using PCM that the exceptions are caught, so all PCM functions should occur within a try{} catch(PCM::Exception& e) {} block.

Definition at line 61 of file PCMException.h.


Getters & setters
const Exception::ExceptionType &	getType () const
	Getter of mType.
const std::string &	getDescription () const
	Getter of mDescription.
const std::string &	getFileName () const
	Getter of mFileName.
const std::string &	getFunctionName () const
	Getter of mFunctionName.
const u32 &	getLineNumber () const
	Getter of mLineNumber.
static Exception *	getLastException ()
	Getter of mLastException.
Public Types
	INTERNAL_ERROR
	Unknown internal error (mostly occured by another library).
	NULL_POINTER_ERROR
	Nullpointer error.
	INVALID_NAME_ERROR
	Invalid name error.
	INVALID_ENUM_ERROR
	Invalid enumerated value error.
	INVALID_VALUE_ERROR
	Invalid value error.
	INVALID_OBJECT_ERROR
	Invalid object error.
	INVALID_CLASS_ERROR
	Invalid class error (not proper derived class).
	INVALID_OPERATION_ERROR
	Invalid operation error.
	OPERATION_NOT_SUPPORTED_ERROR
	Operation is not supported on this platform.
	OUT_OF_MEMORY_ERROR
	Out of memory error.
	FILE_IO_ERROR
	File I/O error.
	FILE_FORMAT_ERROR
	Invalid file format error.
	USER_BREAK_ERROR
	The user stopped the application.
	SCRIPT_ERROR
	Error in a script file.
	XLIB_ERROR
	Xlib error.
enum	ExceptionType { INTERNAL_ERROR, NULL_POINTER_ERROR, INVALID_NAME_ERROR, INVALID_ENUM_ERROR, INVALID_VALUE_ERROR, INVALID_OBJECT_ERROR, INVALID_CLASS_ERROR, INVALID_OPERATION_ERROR, OPERATION_NOT_SUPPORTED_ERROR, OUT_OF_MEMORY_ERROR, FILE_IO_ERROR, FILE_FORMAT_ERROR, USER_BREAK_ERROR, SCRIPT_ERROR, XLIB_ERROR }
	Definitions of error codes. More...
Public Member Functions
Constructors & destructor
	Exception (const ExceptionType &type=INTERNAL_ERROR, const std::string &description="unknown", const std::string &fileName="unknown", const std::string &functionName="unknown", const u32 &lineNumber=0)
	Default constructor.
Static Public Member Functions
Class methods
static std::string	translateType (const Exception::ExceptionType &type)
	Translate type to human readable format.
Protected Attributes
Variables
ExceptionType	mType
	Type of the exception.
std::string	mDescription
	Textual description of the exception.
std::string	mFileName
	Name of the file where the exception was thrown.
std::string	mFunctionName
	Name of the function where the exception was thrown.
u32	mLineNumber
	Number of the line where the exception was thrown.
Static Protected Attributes
Class variables
static Exception *	mLastException = 0
	Pointer to the last raised exception.

Member Enumeration Documentation

enum ParCompMark::Exception::ExceptionType

Definitions of error codes.

Enumerator:

INTERNAL_ERROR	Unknown internal error (mostly occured by another library).
NULL_POINTER_ERROR	Nullpointer error.
INVALID_NAME_ERROR	Invalid name error.
INVALID_ENUM_ERROR	Invalid enumerated value error.
INVALID_VALUE_ERROR	Invalid value error.
INVALID_OBJECT_ERROR	Invalid object error.
INVALID_CLASS_ERROR	Invalid class error (not proper derived class).
INVALID_OPERATION_ERROR	Invalid operation error.
OPERATION_NOT_SUPPORTED_ERROR	Operation is not supported on this platform.
OUT_OF_MEMORY_ERROR	Out of memory error.
FILE_IO_ERROR	File I/O error.
FILE_FORMAT_ERROR	Invalid file format error.
USER_BREAK_ERROR	The user stopped the application.
SCRIPT_ERROR	Error in a script file.
XLIB_ERROR	Xlib error.

Definition at line 78 of file PCMException.h.

Constructor & Destructor Documentation

ParCompMark::Exception::Exception	(	const ExceptionType &	type = `INTERNAL_ERROR`,
		const std::string &	description = `"unknown"`,
		const std::string &	fileName = `"unknown"`,
		const std::string &	functionName = `"unknown"`,
		const u32 &	lineNumber = `0`
	)			`[inline]`

Default constructor.

Parameters:

`[in]`	type	Type of exception.
`[in]`	description	Textual description of the exception.
`[in]`	fileName	Name of the file where the exception was thrown.
`[in]`	functionName	Name of the function where the exception was thrown.
`[in]`	lineNumber	Number of the line where the exception was thrown.