Class AmiException

• Defined in File exception.h

Inheritance Relationships

Base Type

• public std::exception

Derived Types

• public amici::CvodeException (Class CvodeException)

• public amici::IDAException (Class IDAException)

• public amici::IntegrationFailure (Class IntegrationFailure)

• public amici::IntegrationFailureB (Class IntegrationFailureB)

• public amici::NewtonFailure (Class NewtonFailure)

• public amici::SetupFailure (Class SetupFailure)

Class Documentation

class AmiException : public std::exception

AMICI exception class.

Has a printf style interface to allow easy generation of error messages

Subclassed by amici::CvodeException, amici::IDAException, amici::IntegrationFailure, amici::IntegrationFailureB, amici::NewtonFailure, amici::SetupFailure

Public Functions

AmiException(int const first_frame = 3)

Default ctor.

Parameters:

first_frame – Index of first frame to include

explicit AmiException(char const *fmt, ...)

Constructor with printf style interface.

Parameters:

• fmt – error message with printf format

• ... – printf formatting variables

char const *what() const noexcept override

Override of default error message function.

Returns:

msg error message

char const *getBacktrace() const

Returns the stored backtrace.

Returns:

trace backtrace

void storeBacktrace(int nMaxFrames, int const first_frame)

Stores the current backtrace.

Parameters:

• nMaxFrames – number of frames to go back in stacktrace

• first_frame – Index of first frame to include

Protected Functions

void storeMessage(char const *fmt, va_list argptr)

Store the provided message.

Parameters:

• fmt – error message with printf format

• argptr – pointer to variadic argument list