Exception.hpp File Reference

#include <string>
#include <iostream>
#include <cfloat>
#include <climits>
#include <cstdlib>
#include <boost/preprocessor/stringize.hpp>

Include dependency graph for Exception.hpp:

Go to the source code of this file.

Classes

class Exception

Defines

#define EXCEPTION(message) throw Exception(message, __FILE__, __LINE__)

#define EXCEPT_IF_NOT(test) if (!(test)) EXCEPTION("Assertion tripped: " BOOST_PP_STRINGIZE(test))

#define UNUSED_OPT(var)

#define EXPECT0(cmd, arg)

#define MPI_ABORT_IF_NON0_WITH_MSG(retcode, msg)

#define MPIABORTIFNON0(cmd, arg)

#define EXPECTNON0(cmd, arg)

#define IGNORE_RET(cmd, arg)

Variables

const unsigned UNSIGNED_UNSET = UINT_MAX

const int INT_UNSET = INT_MAX

const double DOUBLE_UNSET = DBL_MAX

Detailed Description

Contains the Exception class, along with some macros that are widely used throughout the code.

Definition in file Exception.hpp.

Define Documentation

#define EXCEPT_IF_NOT ( test ) if (!(test)) EXCEPTION("Assertion tripped: " BOOST_PP_STRINGIZE(test))

Convenience macro for changing an assert into an exception - has the same calling semantics, but throws.

Parameters:

test

the test that must always be true.

Definition at line 126 of file Exception.hpp.

Referenced by CellMLToSharedLibraryConverter::ConvertCellmlToSo().

#define EXCEPTION ( message ) throw Exception(message, __FILE__, __LINE__)

Convenience macro for throwing an exception, in order to add file and line info.

Parameters:

message

the exception message

Definition at line 115 of file Exception.hpp.

#define EXPECT0	(	cmd,
		arg		)

Value:

{ \
    std::string _arg(arg); \
    int ret = cmd(_arg.c_str()); \
    if (ret != 0) { \
        EXCEPTION("Error executing command: " #cmd "(" + _arg + ")"); \
    } }

Handy for calling functions like system which return non-zero on error. Throws if an error occurs.

Note:: DO NOT use this macro within an if (PetscTools::AmMaster) block, as then you'll get deadlock if an exception is thrown when running in parallel! (Unless the block is wrapped in a try-catch and exception replication handler.) Instead, use MPIABORTIFNON0.

Parameters:

	cmd	command to call
	arg	its argument (will be converted to std::string)

Definition at line 152 of file Exception.hpp.

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

#define EXPECTNON0	(	cmd,
		arg		)

Value:

{ \
    std::string _arg = (arg); \
    int ret = cmd(_arg.c_str()); \
    if (ret == 0) { \
        EXCEPTION("Command: " #cmd "(" + _arg + ") succeeded and it shouldn't have"); \
    } }

Handy for calling functions like system which return non-zero on error. This time we expect failure; throws if the command succeeds.

Parameters:

	cmd	command to call
	arg	its argument (will be converted to std::string)

Definition at line 190 of file Exception.hpp.

#define IGNORE_RET	(	cmd,
		arg		)

Value:

{ \
    std::string _arg = (arg); \
    int ret = cmd(_arg.c_str()); \
    ret = ret; \
    }

Handy for calling functions like system which return non-zero on error. This version ignores the return code, in case you don't care about errors for some reason...

Parameters:

	cmd	command to call
	arg	its argument (will be converted to std::string)

Definition at line 203 of file Exception.hpp.

#define MPI_ABORT_IF_NON0_WITH_MSG	(	retcode,
		msg		)

Value:

if (retcode != 0) { \
        std::cerr << msg << std::endl << std::flush; \
        MPI_Abort(PETSC_COMM_WORLD, -1); \
    }

Handy for calling functions like system which return non-zero on error. MPI_Abort if the return code is non-zero, printing a message to stderr.

Parameters:

	retcode	command return code
	msg	error message to display

Definition at line 166 of file Exception.hpp.

#define MPIABORTIFNON0	(	cmd,
		arg		)

Value:

{ \
    std::string _arg(arg); \
    int ret = cmd(_arg.c_str()); \
    MPI_ABORT_IF_NON0_WITH_MSG(ret, "Error executing command: " #cmd "(" + _arg + ")") \
    }

Handy for calling functions like system which return non-zero on error. MPI_Abort if an error occurs.

Parameters:

	cmd	command to call
	arg	its argument (will be converted to std::string)

Definition at line 178 of file Exception.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), OutputFileHandler::CopyFileTo(), HeartConfig::CopySchema(), CardiacSimulation::CreateAndRun(), OutputDirectoryFifoQueue::CreateNextDir(), OutputFileHandler::MakeFoldersAndReturnFullPath(), OutputFileHandler::OutputFileHandler(), AbstractTetrahedralMesh< SPACE_DIM, SPACE_DIM >::save(), and AbstractCardiacTissue< SPACE_DIM >::save().

#define UNUSED_OPT ( var )

This is to cope with NDEBUG causing variables to not be used, when they are only used in assert()s.

Parameters:

var

the "unused" variable

Definition at line 137 of file Exception.hpp.

Variable Documentation

const double DOUBLE_UNSET = DBL_MAX

Use when initialising a double variable that doesn't have a sensible default value.

Definition at line 49 of file Exception.hpp.

Referenced by AbstractCvodeCell::Compute(), CellCycleModelOdeHandler::GetDt(), AbstractOdeBasedCellCycleModel::GetOdeStopTime(), NhsContractionModel::SetInputParameters(), Nash2004ContractionModel::SetInputParameters(), Kerchoffs2003ContractionModel::SetInputParameters(), and AbstractCvodeCell::SolveAndUpdateState().

const int INT_UNSET = INT_MAX

Use when initialising an int variable that doesn't have a sensible default value.

Definition at line 47 of file Exception.hpp.

const unsigned UNSIGNED_UNSET = UINT_MAX

Use when initialising an unsigned variable that doesn't have a sensible default value.

Definition at line 45 of file Exception.hpp.

Referenced by CardiacElectroMechanicsProblem< DIM >::CardiacElectroMechanicsProblem(), CardiacElectroMechanicsProblem< DIM >::DetermineWatchedNodes(), AbstractCellPopulation< DIM >::GenerateCellResults(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetDelaunayNodeIndexCorrespondingToVoronoiElementIndex(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetVoronoiElementIndexCorrespondingToDelaunayNodeIndex(), CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::Initialise(), CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::IsSetUp(), CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::Reset(), VertexBasedCellPopulation< DIM >::WriteVtkResultsToFile(), NodeBasedCellPopulation< DIM >::WriteVtkResultsToFile(), MeshBasedCellPopulationWithGhostNodes< DIM >::WriteVtkResultsToFile(), and MeshBasedCellPopulation< DIM >::WriteVtkResultsToFile().


Classes
class	Exception
Defines
#define	EXCEPTION(message) throw Exception(message, __FILE__, __LINE__)
#define	EXCEPT_IF_NOT(test) if (!(test)) EXCEPTION("Assertion tripped: " BOOST_PP_STRINGIZE(test))
#define	UNUSED_OPT(var)
#define	EXPECT0(cmd, arg)
#define	MPI_ABORT_IF_NON0_WITH_MSG(retcode, msg)
#define	MPIABORTIFNON0(cmd, arg)
#define	EXPECTNON0(cmd, arg)
#define	IGNORE_RET(cmd, arg)
Variables
const unsigned	UNSIGNED_UNSET = UINT_MAX
const int	INT_UNSET = INT_MAX
const double	DOUBLE_UNSET = DBL_MAX