pni::core::exception Class Reference

Exceptions base class. More...

#include <exceptions.hpp>

Inheritance diagram for pni::core::exception:

Public Types
typedef std::list < exception_record > ::const_iterator	const_iterator
	const iterator over the error record

Public Member Functions
	exception ()
	default constructor
	exception (const string &n)
	constructor More...
	exception (const string &n, const exception_record &rec)
	constructor More...
	exception (const string &n, const exception_record &rec, const string &d)
	constructor More...
virtual	~exception () throw ()
	virtual destructor
void	name (const std::string &name)
	set the exception name More...
const string &	name () const
	get the exceptions name More...
void	append (const exception_record &n)
	add a new issuer More...
void	description (const std::string &desc)
	set exception desccription More...
const string &	description () const
	get the exceptions description More...
const_iterator	begin () const
	get iterator to first error record More...
const_iterator	end () const
	get iterator to the last error record More...

Protected Member Functions
std::ostream &	print (std::ostream &o) const
	ouptut method More...

Private Attributes
string	_name
	name of the exception
string	_description
	description of the error occured
std::list< exception_record >	_records
	exception records

Friends
std::ostream &	operator<< (std::ostream &, const exception &)
	output operator for exceptions

Detailed Description

This is the base class for all exceptions used in this library.

Constructor & Destructor Documentation

pni::core::exception::exception

(

const string &

n

)

Parameters

n	name of the exception

pni::core::exception::exception	(	const string &	n,
		const exception_record &	rec
	)

Parameters

n	name of the exception
rec	Exception record of the initial location where the error occured

pni::core::exception::exception	(	const string &	n,
		const exception_record &	rec,
		const string &	d
	)

Parameters

n	name of the exception
rec	exception record describing the location of the first occurrence of the error
d	description of the exception

Member Function Documentation

void pni::core::exception::append ( const exception_record &  n )

inline

Use this method to add a new issuer in the case that the exception is re-thrown by an other function or class method.

...
catch(exception &error)
{
    error.append(EXCEPTION_RECORD);
    throw error;
}

With this a particular exception can be traced througout the entire code.

Parameters

n	exception_record to append

const_iterator pni::core::exception::begin ( ) const

inline

Return get a const iterator to the first error record in the class.

Returns

iterator to first exception record

void pni::core::exception::description ( const std::string &  desc )

inline

Parameters

desc	description of the exception

const string& pni::core::exception::description ( ) const

inline

Returns

reference to the string object with the exceptions description

const_iterator pni::core::exception::end ( ) const

inline

Return a const iterator pointing to the last+1 element in the exception record list.

Returns

iterator to last+1 exception record

void pni::core::exception::name ( const std::string &  name )

inline

Parameters

name	exception name

const string& pni::core::exception::name ( ) const

inline

Returns

reference to the string object holding the name

std::ostream& pni::core::exception::print ( std::ostream &  o ) const

protected

Protected method to be used by derived classes for implementing exception printing to std::out.

Parameters

o	reference to the ouptput stream

Returns

output stream

---

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

• exceptions.hpp