UAPException Class Reference

This class and its subclasses indicates conditions that a reasonable application might want to catch. More...

#include <UAPException.hpp>

Inherits std::exception.

Inherited by UAPBeamlineExpansionFailedException, UAPIOException, UAPNodeException, UAPNotSupportedException, UAPParameterNotFoundException, and UAPParserException.

Collaboration diagram for UAPException:

[legend]

List of all members.

Public Member Functions
	UAPException (const std::string &_message="Unspecified exception")
	Constructs a new exception with the specified detail message.
	UAPException (const std::string &_message, const UAPException &_cause)
	Constructs a new exception with the specified detail message.
virtual	~UAPException () throw ()
	Destructor.
std::string	getMessage () const
	Returns the detail message string of this exception.
UAPException *	getCause () const
	Returns the cause of this exception or null if the cause is nonexistent or unknown.
void	printStackTrace (std::ostream &_file=std::cerr)
	Prints this exception and its backtrace to the specified file.
virtual std::string	toString () const
	Returns a string object with a short description of this exception.
Friends
std::ostream &	operator<< (std::ostream &os, const UAPException &except)
	Overrides the default output stream operator.

---

Detailed Description

This class and its subclasses indicates conditions that a reasonable application might want to catch.

See also:

std::exception

Definition at line 41 of file UAPException.hpp.

---

Constructor & Destructor Documentation

UAPException::UAPException

(

const std::string &

_message = "Unspecified exception"

)

Constructs a new exception with the specified detail message.

Parameters:

_message

the detail message (default: "Unspecified exception")

Definition at line 30 of file UAPException.cpp.

UAPException::UAPException	(	const std::string &	_message,
		const UAPException &	_cause
	)

Constructs a new exception with the specified detail message.

Parameters:

	_message	the detail message
	_cause	the cause

Definition at line 32 of file UAPException.cpp.

UAPException::~UAPException

(

)

throw () [virtual]

Destructor.

Definition at line 35 of file UAPException.cpp.

---

Member Function Documentation

UAPException * UAPException::getCause

(

)

const

Returns the cause of this exception or null if the cause is nonexistent or unknown.

Returns:

the cause of this exception or null if the cause is nonexistent or unknown.

See also:

UAPException

Definition at line 42 of file UAPException.cpp.

string UAPException::getMessage

(

)

const

Returns the detail message string of this exception.

Returns:

the detail message string of this exception.

Definition at line 37 of file UAPException.cpp.

void UAPException::printStackTrace

(

std::ostream &

_file = std::cerr

)

Prints this exception and its backtrace to the specified file.

Parameters:

_file

the file to use for output (default: standard error stream)

See also:

std::ostream

Definition at line 47 of file UAPException.cpp.

string UAPException::toString

(

)

const [virtual]

Returns a string object with a short description of this exception.

Returns:

a short description of this exception.

See also:

getMessage

Reimplemented in UAPIOException, and UAPNodeException.

Definition at line 55 of file UAPException.cpp.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const UAPException &	except
	)			[friend]

Overrides the default output stream operator.

See also:

toString

Definition at line 60 of file UAPException.cpp.