Exception Class Reference

#include <Exception.hpp>

Collaboration diagram for Exception:

List of all members.

Public Member Functions

Exception (std::string message, std::string filename, const unsigned rLineNumber)

std::string GetMessage () const

Private Attributes

std::string mMessage

Detailed Description

Exception class. All exceptions thrown by this code are currently instances of this class.

Todo:: Might we want this class to inherit from STL exceptions?

Definition at line 49 of file Exception.hpp.

Constructor & Destructor Documentation

Exception::Exception	(	std::string	message,
		std::string	filename,
		const unsigned	rLineNumber
	)

Construct an exception with a message string.

Parameters:

message

the message

Todo:: make this argument a reference?

Parameters:

filename

which source file threw the exception

Todo:: make this argument a reference?

Parameters:

rLineNumber

which line number of the source file threw the exception

Definition at line 34 of file Exception.cpp.

References mMessage.

Member Function Documentation

std::string Exception::GetMessage ( ) const

Get the message associated with the exception

Returns:: The message set when the exception was thrown.

Definition at line 52 of file Exception.cpp.

References mMessage.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), and AbstractCardiacProblem< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::Initialise().

Member Data Documentation

std::string Exception::mMessage [private]

Exception message

Definition at line 52 of file Exception.hpp.

Referenced by Exception(), and GetMessage().

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

/tmp/release_1.1/global/src/Exception.hpp
/tmp/release_1.1/global/src/Exception.cpp


Public Member Functions
	Exception (std::string message, std::string filename, const unsigned rLineNumber)
std::string	GetMessage () const
Private Attributes
std::string	mMessage