Cantera: XML_Error Class Reference

Cantera 2.0

Classs representing a generic XML error condition. More...

Inheritance diagram for XML_Error:

Collaboration diagram for XML_Error:

Public Member Functions
const char *	what () const throw ()
	Get a description of the error.

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

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

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

Protected Member Functions
	XML_Error (int line=0)
	Constructor.

virtual	~XML_Error () throw ()
	destructor

Protected Attributes
int	m_line
	Line number of the file.

std::string	m_msg
	String message for the error.

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

Detailed Description

Classs representing a generic XML error condition.

Definition at line 30 of file xml.cpp.

Constructor & Destructor Documentation

XML_Error ( int line = 0 )

inlineprotected

Constructor.

Note, we don't actually post the error in this class. Therefore, this class can't be used externally. Therefore, it's a protected constructor.

Parameters

line	Number number where the error occurred.

Definition at line 41 of file xml.cpp.

References Cantera::int2str().

virtual ~XML_Error ( ) throw ()

inlineprotectedvirtual

destructor

Definition at line 51 of file xml.cpp.

Member Function Documentation

const char * what ( ) const throw ()

inherited

Get a description of the error.

Definition at line 41 of file ctexceptions.cpp.

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

Referenced by TransportFactory::getLiquidInteractionsTransportData().

void save ( )

inherited

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

Definition at line 33 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(), ChemEquil::estimateEP_Brinkley(), TransportFactory::getLiquidSpeciesTransportData(), TransportFactory::getTransportData(), PseudoBinaryVPSSTP::report(), MolarityIonicVPSSTP::report(), PureFluidPhase::report(), MolalityVPSSTP::report(), ThermoPhase::report(), PureFluidPhase::reportCSV(), MolalityVPSSTP::reportCSV(), ThermoPhase::reportCSV(), ChemEquil::setInitialMoles(), ThermoPhase::setState_TPX(), ThermoPhase::setState_TPY(), MultiTransport::solveLMatrixEquation(), Cantera::vcs_equilibrate(), and Cantera::vcs_equilibrate_1().

std::string getMessage ( ) const

virtualinherited

Method overridden by derived classes to formatted the error message.

Reimplemented in IndexError, and ArraySizeError.

Definition at line 56 of file ctexceptions.cpp.

References CanteraError::msg_.

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

virtual std::string getClass ( ) const

inlinevirtualinherited

Method overridden by derived classes to indicate their type.

Reimplemented in IndexError, and ArraySizeError.

Definition at line 97 of file ctexceptions.h.

Referenced by CanteraError::what().

Member Data Documentation

int m_line

protected

Line number of the file.

Definition at line 56 of file xml.cpp.

std::string m_msg

protected

String message for the error.

Definition at line 59 of file xml.cpp.

std::string procedure_

protectedinherited

The name of the procedure where the exception occurred.

Definition at line 107 of file ctexceptions.h.

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

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

xml.cpp