Chaste  Release::3.4
Exception Class Reference

#include <Exception.hpp>

+ Collaboration diagram for Exception:

Public Member Functions

 Exception (const std::string &rMessage, const std::string &rFilename, unsigned lineNumber)
 
std::string GetMessage () const
 
std::string GetShortMessage () const
 
std::string CheckShortMessage (std::string expected) const
 
std::string CheckShortMessageContains (std::string expected) const
 

Static Public Member Functions

static void Terminate (const std::string &rMessage, const std::string &rFilename, unsigned lineNumber)
 

Protected Member Functions

void SetMessage (const std::string &rMessage, const std::string &rFilename, unsigned lineNumber)
 

Private Attributes

std::string mMessage
 
std::string mShortMessage
 

Detailed Description

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

Definition at line 63 of file Exception.hpp.

Constructor & Destructor Documentation

Exception::Exception ( const std::string &  rMessage,
const std::string &  rFilename,
unsigned  lineNumber 
)

Construct an exception with a message string.

Parameters
rMessagethe message
rFilenamewhich source file threw the exception
lineNumberwhich line number of the source file threw the exception

Definition at line 52 of file Exception.cpp.

References SetMessage().

Member Function Documentation

std::string Exception::CheckShortMessage ( std::string  expected) const

Helper method for checking we have the right exception.

Returns
an empty string when the expected message matches. Checks that mShortMessage matches that given, and a suitable error message string if not.
Parameters
expectedthe expected value of mShortMessage

Definition at line 97 of file Exception.cpp.

References mShortMessage.

std::string Exception::CheckShortMessageContains ( std::string  expected) const

Helper method for checking we have the right exception.

Returns
an empty string when the message contains the expected string. Checks that mShortMessage contains the given string, and returns a suitable error message string if not.
Parameters
expectedsome expected substring of mShortMessage

Definition at line 107 of file Exception.cpp.

References mShortMessage.

Referenced by CardiacSimulation::ReadParametersFromFile().

std::string Exception::GetMessage ( ) const

Get the message associated with the exception with file and line number

Returns
The message set when the exception was thrown including file and line number information

Definition at line 87 of file Exception.cpp.

References mMessage.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), and CellMLToSharedLibraryConverter::ConvertCellmlToSo().

std::string Exception::GetShortMessage ( ) const

Get the message associated with the exception

Returns
The message text set when the exception was thrown.

Definition at line 92 of file Exception.cpp.

References mShortMessage.

Referenced by PropagationPropertiesCalculator::CalculateAllActionPotentialDurationsForNodeRange(), and AbstractCardiacProblem< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::Initialise().

void Exception::SetMessage ( const std::string &  rMessage,
const std::string &  rFilename,
unsigned  lineNumber 
)
protected

Allow subclasses to reset the exception message after construction of the base class, if desired.

Parameters
rMessagethe message
rFilenamewhich source file threw the exception
lineNumberwhich line number of the source file threw the exception

Definition at line 65 of file Exception.cpp.

References ChasteSourceRootDir(), mMessage, mShortMessage, and ChastePosixPathFixer::ToPosix().

Referenced by Exception().

void Exception::Terminate ( const std::string &  rMessage,
const std::string &  rFilename,
unsigned  lineNumber 
)
static

Level 4 error (Termination). Execution cannot continue from this point and hence should be terminated (even when running with NDEBUG or in parallel).

Parameters
rMessageAn error message to appear on the screen
rFilenamewhich source file produced the termination error
lineNumberwhich line number of the source file produced the termination error

Definition at line 118 of file Exception.cpp.

Member Data Documentation

std::string Exception::mMessage
private

Full exception message - includes file and line number.

Definition at line 134 of file Exception.hpp.

Referenced by GetMessage(), and SetMessage().

std::string Exception::mShortMessage
private

Short exception message - just text of the exception.

Definition at line 135 of file Exception.hpp.

Referenced by CheckShortMessage(), CheckShortMessageContains(), GetShortMessage(), and SetMessage().


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