Cantera
3.0.0
|
Base class for exceptions thrown by Cantera classes. More...
#include <ctexceptions.h>
Base class for exceptions thrown by Cantera classes.
This class is the base class for exceptions thrown by Cantera. It inherits from std::exception so that normal error handling operations from applications may automatically handle the errors in their own way.
Definition at line 65 of file ctexceptions.h.
Public Member Functions | |
template<typename... Args> | |
CanteraError (const string &procedure, const string &msg, const Args &... args) | |
Normal Constructor for the CanteraError base class. | |
virtual | ~CanteraError () throw () |
Destructor for base class does nothing. | |
const char * | what () const override throw () |
Get a description of the error. | |
virtual string | getMessage () const |
Method overridden by derived classes to format the error message. | |
virtual string | getMethod () const |
Get the name of the method that threw the exception. | |
virtual string | getClass () const |
Method overridden by derived classes to indicate their type. | |
Protected Member Functions | |
CanteraError () | |
Protected default constructor discourages throwing errors containing no information. | |
CanteraError (const string &procedure) | |
Constructor used by derived classes that override getMessage() | |
Protected Attributes | |
string | procedure_ |
The name of the procedure where the exception occurred. | |
string | formattedMessage_ |
Formatted message returned by what() | |
Private Attributes | |
string | msg_ |
Message associated with the exception. | |
|
inline |
Normal Constructor for the CanteraError base class.
procedure | Name of the function within which the error was generated. For member functions, this should be written as ClassName::functionName . For constructors, this should be ClassName::ClassName . Arguments can be specified to disambiguate overloaded functions, such as ClassName::functionName(int, int) . |
msg | Descriptive string describing the type of error message. This can be a fmt-style format string (that is, using curly braces to indicate fields), which will be used with additional arguments to generate a formatted error message |
args | Arguments which will be used to interpolate the format string |
Definition at line 83 of file ctexceptions.h.
|
inlinevirtual |
Destructor for base class does nothing.
Definition at line 94 of file ctexceptions.h.
|
inlineprotected |
Protected default constructor discourages throwing errors containing no information.
Definition at line 113 of file ctexceptions.h.
|
explicitprotected |
Constructor used by derived classes that override getMessage()
Definition at line 20 of file ctexceptions.cpp.
|
override |
Get a description of the error.
Definition at line 25 of file ctexceptions.cpp.
|
virtual |
Method overridden by derived classes to format the error message.
Reimplemented in ArraySizeError, and IndexError.
Definition at line 45 of file ctexceptions.cpp.
|
virtual |
Get the name of the method that threw the exception.
Definition at line 50 of file ctexceptions.cpp.
|
inlinevirtual |
Method overridden by derived classes to indicate their type.
Reimplemented in InputFileError, ArraySizeError, IndexError, and NotImplementedError.
Definition at line 106 of file ctexceptions.h.
|
protected |
The name of the procedure where the exception occurred.
Definition at line 119 of file ctexceptions.h.
|
mutableprotected |
Formatted message returned by what()
Definition at line 120 of file ctexceptions.h.
|
private |
Message associated with the exception.
Definition at line 123 of file ctexceptions.h.