casa::AipsError Class Reference

Base class for all AIPS++ library errors. More...

#include <Error.h>

Inheritance diagram for casa::AipsError:

List of all members.

Public Types
enum	Category {   BOUNDARY,   INITIALIZATION,   INVALID_ARGUMENT,   CONFORMANCE,   ENVIRONMENT,   SYSTEM,   PERMISSION,   GENERAL }
Public Member Functions
virtual const char *	what () const throw ()
	Simply returns the stored error message.
const String &	getMesg () const
String	getStackTrace () const
AipsError::Category	getCategory () const
void	setMessage (const String &msg) const
	Append a message.
	AipsError (const Char *str, Category c=GENERAL)
	Creates an AipsError and initializes the error message from the parameter.
	AipsError (const String &str, Category c=GENERAL)
	AipsError (const String &msg, const String &filename, uInt lineNumber, Category c=GENERAL)
	AipsError (Category c=GENERAL)
	~AipsError () throw ()
	Destructor which does nothing.
Static Public Member Functions
static String	generateStackTrace ()
static void	getLastInfo (String &message, String &stackTrace)
static String	getLastMessage ()
static String	getLastStackTrace ()
static void	clearLastInfo ()
static String	noMessage ()
static String	noStackTrace ()
Protected Member Functions
void	addStackTrace ()
Protected Attributes
String	message
Category	category
String	stackTrace
Static Protected Attributes
static String	lastMessage
static String	lastStackTrace
static Mutex	lastErrorMutex

---

Detailed Description

Base class for all AIPS++ library errors.

Intended use:

Public interface

Review Status

Reviewed By:

UNKNOWN

Date Reviewed:

before2004/08/25

Prerequisite

• ExcpError

Synopsis

This is the base class for all of the AIPS++ error classes. Because all of the errors have a common base class, any error can be caught with a single catch statement.

This class has a string which allows error messages to be propagated.

Tip: The string member must be handled very carefully because string is also derived from cleanup, thus the message;makePermanent() call in the implementation of the constructors; This prevents the String from being cleaned up in the middle of an exception;

Example

         throw(AipsError("SOME STRING"));

Definition at line 89 of file Error.h.

---

Member Enumeration Documentation

enum casa::AipsError::Category

Enumerator:

BOUNDARY
INITIALIZATION
INVALID_ARGUMENT
CONFORMANCE
ENVIRONMENT
SYSTEM
PERMISSION
GENERAL

Definition at line 93 of file Error.h.

---

Constructor & Destructor Documentation

casa::AipsError::AipsError	(	const Char *	str,
		Category	c = GENERAL
	)

Creates an AipsError and initializes the error message from the parameter.

casa::AipsError::AipsError	(	const String &	str,
		Category	c = GENERAL
	)

casa::AipsError::AipsError	(	const String &	msg,
		const String &	filename,
		uInt	lineNumber,
		Category	c = GENERAL
	)

casa::AipsError::AipsError

(

Category

c = GENERAL

)

casa::AipsError::~AipsError

(

)

throw ()

Destructor which does nothing.

---

Member Function Documentation

void casa::AipsError::addStackTrace

(

)

[protected]

static void casa::AipsError::clearLastInfo

(

)

[static]

static String casa::AipsError::generateStackTrace

(

)

[static]

AipsError::Category casa::AipsError::getCategory

(

)

const [inline]

Definition at line 106 of file Error.h.

References category.

static void casa::AipsError::getLastInfo	(	String &	message,
		String &	stackTrace
	)		[static]

static String casa::AipsError::getLastMessage

(

)

[static]

static String casa::AipsError::getLastStackTrace

(

)

[static]

const String& casa::AipsError::getMesg

(

)

const [inline]

Definition at line 103 of file Error.h.

References message.

Referenced by casa::MSSelectionLogError::handleError().

String casa::AipsError::getStackTrace

(

)

const

static String casa::AipsError::noMessage

(

)

[static]

static String casa::AipsError::noStackTrace

(

)

[static]

void casa::AipsError::setMessage

(

const String &

msg

)

const [inline]

Append a message.

This is used by LogIO when an exception is logged. The message is const to be able to use it for a temporary exception.

Definition at line 111 of file Error.h.

References message.

virtual const char* casa::AipsError::what

(

)

const throw () [inline, virtual]

Simply returns the stored error message.

Definition at line 101 of file Error.h.

References casa::String::c_str(), and message.

---

Member Data Documentation

Category casa::AipsError::category [protected]

Definition at line 143 of file Error.h.

Referenced by getCategory().

Mutex casa::AipsError::lastErrorMutex [static, protected]

Definition at line 148 of file Error.h.

String casa::AipsError::lastMessage [static, protected]

Definition at line 146 of file Error.h.

String casa::AipsError::lastStackTrace [static, protected]

Definition at line 147 of file Error.h.

String casa::AipsError::message [protected]

Definition at line 142 of file Error.h.

Referenced by getMesg(), setMessage(), and what().

String casa::AipsError::stackTrace [protected]

Definition at line 144 of file Error.h.

---

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

• casacore/casa/Exceptions/Error.h