AlkException Class Reference

#include <alkexception.h>

Public Member Functions
	AlkException (const QString &msg, const QString &file, const unsigned long line)
const QString &	file () const
unsigned long	line () const
const QString &	what () const

Detailed Description

This class describes an exception that is thrown by the engine in case of a failure.

Definition at line 25 of file alkexception.h.

Constructor & Destructor Documentation

AlkException()

AlkException::AlkException	(	const QString &	msg,
		const QString &	file,
		const unsigned long	line )

The constructor to create a new ALKEXCEPTION object.

Parameters

msg	reference to QString containing the message
file	reference to QString containing the name of the sourcefile where the exception was thrown
line	unsigned long containing the line number of the line where the exception was thrown in the file.

An easier way to use this constructor is to use the macro ALKEXCEPTION(text) instead. It automatically assigns the file and line parameter to the correct values.

Definition at line 11 of file alkexception.cpp.

~AlkException()

AlkException::~AlkException

(

)

Definition at line 20 of file alkexception.cpp.

Member Function Documentation

file()

const QString & AlkException::file ( ) const

inline

This method is used to return the filename that was passed during the creation of the exception object.

Returns

reference to QString containing the filename

Definition at line 72 of file alkexception.h.

line()

unsigned long AlkException::line ( ) const

inline

This method is used to return the linenumber that was passed during the creation of the exception object.

Returns

long integer containing the line number

Definition at line 83 of file alkexception.h.

what()

const QString & AlkException::what ( ) const

inline

This method is used to return the message that was passed during the creation of the exception object.

Returns

reference to QString containing the message

Definition at line 61 of file alkexception.h.

---

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

• alkexception.h
• alkexception.cpp