casacore::IndexError Class Reference

Base class for all indexing errors. More...

#include <Error.h>

Public Member Functions
	IndexError (const Char *str, Category c=BOUNDARY)
	Creates an GeneralIndexError and initializes the error message from the parameter.
	IndexError (const String &str, Category c=BOUNDARY)
	IndexError (Category c=BOUNDARY)
	~IndexError () noexcept
	Destructor which does nothing.
Public Member Functions inherited from casacore::AipsError
virtual const char *	what () const noexcept
	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 () noexcept
	Destructor which does nothing.

Additional Inherited Members
Public Types inherited from casacore::AipsError
enum	Category {   BOUNDARY ,   INITIALIZATION ,   INVALID_ARGUMENT ,   CONFORMANCE ,   ENVIRONMENT ,   SYSTEM ,   PERMISSION ,   GENERAL }
Static Public Member Functions inherited from casacore::AipsError
static void	getLastInfo (String &message, String &stackTrace)
	Get or clear the stacktrace info.
static String	getLastMessage ()
static String	getLastStackTrace ()
static void	clearLastInfo ()
static AipsError	repackageAipsError (AipsError &error, const String &message, const char *file, Int line, const char *func)
	Repackage an exception.
static void	throwIf (Bool condition, const String &message, const char *file, Int line, const char *func="")
	Throw if the condition is true.
static void	throwIfError (Int errorCode, const String &prefix, const char *file, Int line, const char *func="")
	Throw if the system error code is not 0.
Protected Member Functions inherited from casacore::AipsError
void	addStackTrace ()
	Add the stack trace to the message (if USE_STACKTRACE is set).
Protected Attributes inherited from casacore::AipsError
String	message
Category	category
String	stackTrace

Detailed Description

Base class for all indexing errors.

Intended use:

Public interface

Review Status

Reviewed By:

UNKNOWN

Date Reviewed:

before2004/08/25

Synopsis

This class is the base class of all IndexErrors. It is defined to allow the user to catch any of the many kinds of IndexErrors which may be thrown. It can also be thrown itself if returning the illegal index value is unimportant.

Example

throw(IndexError("ANY STRING"));

Definition at line 278 of file Error.h.

Constructor & Destructor Documentation

IndexError() [1/3]

casacore::IndexError::IndexError ( const Char * str, Category c = BOUNDARY )

inline

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

Definition at line 284 of file Error.h.

References casacore::AipsError::AipsError(), and casacore::AipsError::BOUNDARY.

Referenced by casacore::indexError< t >::indexError().

IndexError() [2/3]

casacore::IndexError::IndexError ( const String & str, Category c = BOUNDARY )

inline

Definition at line 285 of file Error.h.

References casacore::AipsError::AipsError(), and casacore::AipsError::BOUNDARY.

IndexError() [3/3]

casacore::IndexError::IndexError ( Category c = BOUNDARY )

inline

Definition at line 286 of file Error.h.

References casacore::AipsError::AipsError(), and casacore::AipsError::BOUNDARY.

~IndexError()

casacore::IndexError::~IndexError ( )

noexcept

Destructor which does nothing.

---

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

• casa/Exceptions/Error.h