yane::Utils::IndexException Class Reference

Exception due to accessing invalid array index.

Inheritance diagram for yane::Utils::IndexException:

Collaboration diagram for yane::Utils::IndexException:

List of all members.

Public Member Functions
const char *	debugmessage () const throw ( )
	Function to return debug information.
bool	isType (const std::string &type) const throw ( )
	Function to check if the invocation line of this instance is of the given type.
bool	stackTraceContainsType (const std::string &type) const throw ( )
	Function to check if a certain type of exception is contained in the invocation line of this instance.
virtual const char *	what () const throw ( )
	Function to display the error message.
Static Public Member Functions
static std::string	concatDebugMessage (const char *functionname, int line, std::string message)
	Function to generate a debug error message using the name of the function in which the error occured, the corresponding line number and the error message.
static std::string	concatMessage (const std::string &type, const std::string &message)
	Function to generate a formated error message from a string and an error message.
static void	enableDebugMessage (bool enable=false)
	Function to globally set the output of debug information using the what() message.
Static Public Attributes
static const std::string	TYPE = std::string ( "yane::Utils::IndexException" )
	Type string of the exception.
Protected Member Functions
void	addType (std::string type)
	Function to add a type string.
Protected Attributes
std::string	_debugmess
	Debug information, deprecated and to be remove in next release.
std::string	_message
	Error message, deprecated and to be removed in next release.
int	_number
	Length of the invocation line.
std::vector< std::string >	_stacktypes
	Type strings of the exception stack.
std::vector< std::string >	_types
	Type strings of all elements of the invocation line.
Static Protected Attributes
static bool	_printdebug = false
	Decision variable whether debug information are to be displayed.

---

Member Function Documentation

LIB_EXPORT void yane::Utils::Exception::addType

(

std::string

type

)

[protected, inherited]

Function to add a type string

Parameters:

type	Type string

LIB_EXPORT std::string yane::Utils::Exception::concatDebugMessage	(	const char *	functionname,
		int	line,
		std::string	message
	)		[static, inherited]

Function to generate a debug error message using the name of the function in which the error occured, the corresponding line number and the error message

Parameters:

functionname	Name of the function in which the error occured
line	Line number in which the error occured
message	Error message

Returns:

Formated output of the debug error message

LIB_EXPORT std::string yane::Utils::Exception::concatMessage	(	const std::string &	type,
		const std::string &	message
	)		[static, inherited]

Function to generate a formated error message from a string and an error message

Parameters:

type	Type string
message	Error message

Returns:

Formated error message

LIB_EXPORT const char * yane::Utils::Exception::debugmessage

(

)

const throw ( ) [inherited]

Function to return debug information

Returns:

Debug information

LIB_EXPORT void yane::Utils::Exception::enableDebugMessage

(

bool

enable = false

)

[static, inherited]

Function to globally set the output of debug information using the what() message

Parameters:

enable

true if debug information is to be displayed

LIB_EXPORT bool yane::Utils::Exception::isType

(

const std::string &

type

)

const throw ( ) [inherited]

Function to check if the invocation line of this instance is of the given type

Parameters:

type	Type string

Returns:

true if the type is contained within the invocation line of this instance

LIB_EXPORT bool yane::Utils::Exception::stackTraceContainsType

(

const std::string &

type

)

const throw ( ) [inherited]

Function to check if a certain type of exception is contained in the invocation line of this instance

Parameters:

type	Type string

Returns:

true if the type is contained within the invocation line of this instance

LIB_EXPORT const char * yane::Utils::Exception::what

(

)

const throw ( ) [virtual, inherited]

Function to display the error message

Returns:

Error message