DexelaException Class Reference

This class contains information about any possible error's in the API. In the event of a problem a DexelaException will be thrown.
Note: It is suggested that you wrap your code in a try-catch block to ensure that if any errors occur you can detect (and properly handle them) in your code. More...

#include <DexelaException.h>

Inheritance diagram for DexelaException:

Public Member Functions
	DexelaException (const char *message, Derr code, int line, const char *filename, const char *function, int transportEr, const char *transportMessage)
	Constructor for the DexelaException Class. More...
	DexelaException (const DexelaException &ex, const char *function)
	Copy constructor for the DexelaException Class. More...
	~DexelaException (void) throw ()
	DexelaException destructor. More...
const char *	what () const throw ()
	Function for retriveing the exception's error message. More...
Derr	GetCode ()
	Function for retriveing the exception's Derr code. More...
int	GetTransportError ()
	Function for retriveing the exception's low-level transport error code. Note: This code (along with line-number, and file-name)can be sent to PerkinElmer support for further information about possible causes of the exception. More...
const char *	GetFileName ()
	Function for retriveing the name of the (low-level) source file from which the exception was thrown. Note: This information (along with line-number, and transport error) can be sent to PerkinElmer support for further information about possible causes of the exception. More...
int	GetLineNumber ()
	Function for retriveing line-number of the source of the (low-level) exception throw. Note: This number (along with transport-error and file-name)can be sent to PerkinElmer support for further information about possible causes of the exception. More...
const char *	GetFunctionName ()
	Function for retriveing the name of the (top-level) function from which the error was thrown. Note:This should help to find the function that is causing the exception. More...
const char *	GetTransportMessage ()
	Function for retriveing the (low-level) message from the transport library. Note: This message (along with transport-error, line number and file-name)can be sent to PerkinElmer support for further information about possible causes of the exception. More...

Static Public Member Functions
static void	LoadErrorStrings (const char *filename)

Detailed Description

This class contains information about any possible error's in the API. In the event of a problem a DexelaException will be thrown.
Note: It is suggested that you wrap your code in a try-catch block to ensure that if any errors occur you can detect (and properly handle them) in your code.

Constructor & Destructor Documentation

DexelaException::DexelaException	(	const char *	message,
		Derr	code,
		int	line,
		const char *	filename,
		const char *	function,
		int	transportEr,
		const char *	transportMessage
	)

Constructor for the DexelaException Class.

Parameters

message	The error message, detailing the source of the exception.
code	The Derr error code associated with the exception.
line	The (low-level) line-number of the source of the exception.
filename	The (low-level) name of the source file that was the source of the exception.
function	The (top-level) name of the function in which the exception was thrown.
transportEr	The (low-level) transport error that may associated with the exception.
transportMessage	The (low-level) transport layer error message. This may be empty depending on the source of the error.

DexelaException::DexelaException	(	const DexelaException &	ex,
		const char *	function
	)

Copy constructor for the DexelaException Class.

Parameters

ex	The DexelaException object from which to copy the low-level information about the source of the exception.
function	The top-level name of the function in which the exception was thrown.

DexelaException::~DexelaException	(	void		)
throw	(
	)

DexelaException destructor.

Member Function Documentation

Derr DexelaException::GetCode

(

)

Function for retriveing the exception's Derr code.

Returns

A member of the Derr enumeration detailing the exception's error code.

const char * DexelaException::GetFileName

(

)

Function for retriveing the name of the (low-level) source file from which the exception was thrown.
Note: This information (along with line-number, and transport error) can be sent to PerkinElmer support for further information about possible causes of the exception.

Returns

A string containing the name of the (low-level) source file from which the exception was thrown.

const char * DexelaException::GetFunctionName

(

)

Function for retriveing the name of the (top-level) function from which the error was thrown.
Note:This should help to find the function that is causing the exception.

Returns

A string containing the name of the (top-level) function from which the exception was thrown.

int DexelaException::GetLineNumber

(

)

Function for retriveing line-number of the source of the (low-level) exception throw.
Note: This number (along with transport-error and file-name)can be sent to PerkinElmer support for further information about possible causes of the exception.

Returns

An integer detailing the exception's low-level line number.

int DexelaException::GetTransportError

(

)

Function for retriveing the exception's low-level transport error code.
Note: This code (along with line-number, and file-name)can be sent to PerkinElmer support for further information about possible causes of the exception.

Returns

An integer detailing the exception's low-level transport error code.

const char * DexelaException::GetTransportMessage

(

)

Function for retriveing the (low-level) message from the transport library.
Note: This message (along with transport-error, line number and file-name)can be sent to PerkinElmer support for further information about possible causes of the exception.

Returns

A string containing the low-level transport layer errror message.

const char * DexelaException::what	(		)	const
throw	(
	)

Function for retriveing the exception's error message.

Returns

A string containing the exception's error message.

---

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

• DexelaException.h
• DexelaException.cpp