Cantera: CanteraError Class Reference

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

#include <ctexceptions.h>

Inheritance diagram for CanteraError:

Public Member Functions
	CanteraError (const std::string &procedure, const std::string &msg)
	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 99 of file ctexceptions.h.

Constructor & Destructor Documentation

CanteraError	(	const std::string &	procedure,
		const std::string &	msg
	)

Normal Constructor for the CanteraError base class.

In the constructor, a call to the Application class is made to store the strings associated with the generated error condition.

Parameters

procedure	String name for the function within which the error was generated.
msg	Descriptive string describing the type of error message.

Definition at line 17 of file ctexceptions.cpp.

References CanteraError::save().

virtual ~CanteraError	(		)
throw	(
	)

inlinevirtual

Destructor for base class does nothing.

Definition at line 114 of file ctexceptions.h.

CanteraError ( )

inlineprotected

Protected default constructor discourages throwing errors containing no information.

Definition at line 132 of file ctexceptions.h.

CanteraError ( const std::string & procedure )

explicitprotected

Constructor used by derived classes that override getMessage()

Definition at line 26 of file ctexceptions.cpp.

References CanteraError::save().

Member Function Documentation

const char * what	(		)	const
throw	(
	)

Get a description of the error.

Definition at line 42 of file ctexceptions.cpp.

References CanteraError::formattedMessage_, CanteraError::getClass(), CanteraError::getMessage(), and CanteraError::procedure_.

Referenced by Cantera::cvodes_rhs(), and TransportFactory::getLiquidInteractionsTransportData().

void save ( )

Function to put this error onto Cantera's error stack.

Definition at line 34 of file ctexceptions.cpp.

References Application::addError(), CanteraError::getMessage(), Application::Instance(), CanteraError::procedure_, and CanteraError::saved_.

Referenced by CanteraError::CanteraError(), Cantera::equilibrate(), ChemEquil::equilibrate(), MultiPhase::equilibrate_MultiPhaseEquil(), ChemEquil::estimateEP_Brinkley(), TransportFactory::getLiquidSpeciesTransportData(), PseudoBinaryVPSSTP::report(), MolarityIonicVPSSTP::report(), PureFluidPhase::report(), MolalityVPSSTP::report(), ThermoPhase::report(), ChemEquil::setInitialMoles(), Cantera::vcs_equilibrate(), and Cantera::vcs_equilibrate_1().

std::string getMessage ( ) const

virtual

Method overridden by derived classes to format the error message.

Reimplemented in IndexError, ArraySizeError, and XML_Error.

Definition at line 62 of file ctexceptions.cpp.

References CanteraError::msg_.

Referenced by CanteraError::save(), and CanteraError::what().

virtual std::string getClass ( ) const

inlinevirtual

Method overridden by derived classes to indicate their type.

Reimplemented in NotImplementedError, IndexError, ArraySizeError, XML_NoChild, and XML_TagMismatch.

Definition at line 126 of file ctexceptions.h.

Referenced by CanteraError::what().

Member Data Documentation

std::string procedure_

protected

The name of the procedure where the exception occurred.

Definition at line 138 of file ctexceptions.h.

Referenced by CanteraError::save(), and CanteraError::what().

std::string formattedMessage_

mutableprotected

Formatted message returned by what()

Definition at line 139 of file ctexceptions.h.

Referenced by CanteraError::what().

std::string msg_

private

Message associated with the exception.

Definition at line 142 of file ctexceptions.h.

Referenced by CanteraError::getMessage().

bool saved_

private

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

Definition at line 143 of file ctexceptions.h.

Referenced by CanteraError::save().

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