cms::CMSException Class Reference

#include <src/main/cms/CMSException.h>

---

Detailed Description

This class represents an error that has occurred in cms.

Public Member Functions
	CMSException () throw ()
virtual	~CMSException () throw ()
virtual std::string	getMessage () const =0
	Gets the cause of the error.
virtual void	setMark (const char *file, const int lineNumber)=0
	Adds a file/line number to the stack trace.
virtual CMSException *	clone () const =0
	Clones this exception.
virtual std::vector < std::pair < std::string, int > >	getStackTrace () const =0
	Provides the stack trace for every point where this exception was caught, marked, and rethrown.
virtual void	printStackTrace () const =0
	Prints the stack trace to std::err.
virtual void	printStackTrace (std::ostream &stream) const =0
	Prints the stack trace to the given output stream.
virtual std::string	getStackTraceString () const =0
	Gets the stack trace as one contiguous string.

---

Constructor & Destructor Documentation

cms::CMSException::CMSException

(

)

throw () [inline]

virtual cms::CMSException::~CMSException

(

)

throw () [inline, virtual]

---

Member Function Documentation

virtual std::string cms::CMSException::getMessage

(

)

const [pure virtual]

Gets the cause of the error.

Returns:

string errors message

virtual void cms::CMSException::setMark	(	const char *	file,
		const int	lineNumber
	)			[pure virtual]

Adds a file/line number to the stack trace.

Parameters:

	file	The name of the file calling this method (use __FILE__).
	lineNumber	The line number in the calling file (use __LINE__).

virtual CMSException* cms::CMSException::clone

(

)

const [pure virtual]

Clones this exception.

This is useful for cases where you need to preserve the type of the original exception as well as the message. All subclasses should override.

Returns:

Copy of this Exception object

virtual std::vector< std::pair< std::string, int> > cms::CMSException::getStackTrace

(

)

const [pure virtual]

Provides the stack trace for every point where this exception was caught, marked, and rethrown.

Returns:

vector containing stack trace strings

virtual void cms::CMSException::printStackTrace

(

)

const [pure virtual]

Prints the stack trace to std::err.

virtual void cms::CMSException::printStackTrace

(

std::ostream &

stream

)

const [pure virtual]

Prints the stack trace to the given output stream.

Parameters:

stream

the target output stream.

virtual std::string cms::CMSException::getStackTraceString

(

)

const [pure virtual]

Gets the stack trace as one contiguous string.

Returns:

string with formatted stack trace data

---

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

• src/main/cms/CMSException.h

---