Base class for exceptions thrown by Cantera classes. More...

#include <ctexceptions.h>

Inheritance diagram for CanteraError:

Public Member Functions
template<typename... Args>
	CanteraError (const std::string &procedure, const std::string &msg, const Args &... args)
	Normal Constructor for the CanteraError base class. More...

virtual	~CanteraError () throw ()
	Destructor for base class does nothing. More...

const char *	what () const throw ()
	Get a description of the error. More...

void	save ()
	Function to put this error onto Cantera's error stack. More...

virtual std::string	getMessage () const
	Method overridden by derived classes to format the error message. More...

virtual std::string	getClass () const
	Method overridden by derived classes to indicate their type. More...

Protected Member Functions
	CanteraError ()
	Protected default constructor discourages throwing errors containing no information. More...

	CanteraError (const std::string &procedure)
	Constructor used by derived classes that override getMessage() More...

Protected Attributes
std::string	procedure_
	The name of the procedure where the exception occurred. More...

std::string	formattedMessage_
	Formatted message returned by what() More...

Private Attributes
std::string	msg_
	Message associated with the exception. More...

bool	saved_
	Exception has already been saved to Cantera's error stack. More...

Detailed Description

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.

Constructor & Destructor Documentation

◆ CanteraError() [1/3]

CanteraError	(	const std::string &	procedure,
		const std::string &	msg,
		const Args &...	args
	)

inline

Normal Constructor for the CanteraError base class.

Parameters

procedure	String name for the function within which the error was generated.
msg	Descriptive string describing the type of error message. This can be a fmt-style format string (i.e. 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 79 of file ctexceptions.h.

References CanteraError::msg_.