bpp::ParameterException Class Reference

The parameter exception base class. More...

#include <Bpp/Numeric/ParameterExceptions.h>

Inheritance diagram for bpp::ParameterException:

Collaboration diagram for bpp::ParameterException:

Public Member Functions
	ParameterException (const std::string &text, const Parameter *param)
	Build a new ParameterException object. More...
	ParameterException (const ParameterException &pe)
ParameterException &	operator= (const ParameterException &pe)
virtual	~ParameterException () throw ()
virtual const Parameter *	getParameter () const
	Get the parameter that threw the exception. More...
const char *	what () const throw ()
	Method to get the message of the exception (STL method redefinition). More...

Protected Attributes
std::string	message_

Private Attributes
const Parameter *	parameter_

Detailed Description

The parameter exception base class.

See Also

Exception

Definition at line 59 of file ParameterExceptions.h.

Constructor & Destructor Documentation

ParameterException::ParameterException	(	const std::string &	text,
		const Parameter *	param
	)

Build a new ParameterException object.

Parameters

text	A message to be passed to the exception hierarchy.
param	A const pointer toward the parameter that threw the exception.

Definition at line 51 of file ParameterExceptions.cpp.

bpp::ParameterException::ParameterException ( const ParameterException &  pe )

inline

Definition at line 75 of file ParameterExceptions.h.

virtual bpp::ParameterException::~ParameterException ( ) throw ()

inlinevirtual

Definition at line 86 of file ParameterExceptions.h.

Member Function Documentation

const Parameter * ParameterException::getParameter ( ) const

virtual

Get the parameter that threw the exception.

Returns

A const pointer toward the parameter.

Definition at line 55 of file ParameterExceptions.cpp.

References parameter_.

ParameterException& bpp::ParameterException::operator= ( const ParameterException &  pe )

inline

Definition at line 79 of file ParameterExceptions.h.

References parameter_, and parameter_.

const char* bpp::Exception::what ( ) const throw ()

inlineinherited

Method to get the message of the exception (STL method redefinition).

Returns

The message passed to the exception hierarchy.

Definition at line 86 of file Exceptions.h.

References bpp::Exception::message_.

Member Data Documentation

std::string bpp::Exception::message_

protectedinherited

Definition at line 60 of file Exceptions.h.

Referenced by bpp::Exception::what().

const Parameter* bpp::ParameterException::parameter_

private

Definition at line 64 of file ParameterExceptions.h.

Referenced by getParameter(), operator=(), and operator=().

---

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

• Bpp/Numeric/ParameterExceptions.h
• Bpp/Numeric/ParameterExceptions.cpp