Cantera: ArraySizeError Class Reference

Cantera 2.0

Array size error. More...

#include <ctexceptions.h>

Inheritance diagram for ArraySizeError:

Collaboration diagram for ArraySizeError:

Public Member Functions
	ArraySizeError (std::string procedure, size_t sz, size_t reqd)
	Constructor.

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.

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

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

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

Private Attributes
size_t	sz_

size_t	reqd_

Detailed Description

Array size error.

This error is thrown if a supplied length to a vector supplied to Cantera is too small.

Definition at line 123 of file ctexceptions.h.

Constructor & Destructor Documentation

ArraySizeError	(	std::string	procedure,
		size_t	sz,
		size_t	reqd
	)

inline

Constructor.

The length needed is supplied by the argument, reqd, and the length supplied is given by the argument sz.

Parameters

procedure	String name for the function within which the error was generated.
sz	This is the length supplied to Cantera.
reqd	This is the required length needed by Cantera

Definition at line 136 of file ctexceptions.h.

Member Function Documentation

std::string getMessage ( ) const

virtual

Method overridden by derived classes to formatted the error message.

Reimplemented from CanteraError.

Definition at line 60 of file ctexceptions.cpp.

virtual std::string getClass ( ) const

inlinevirtual

Method overridden by derived classes to indicate their type.

Reimplemented from CanteraError.

Definition at line 140 of file ctexceptions.h.

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().

Member Data Documentation

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 files: