an exception indicating that a requested data selection from a Miriad dataset is not available. More...

#include <MirExceptions.h>

Inheritance diagram for UnavailableMiriadDataSelectionError:

Public Member Functions
	UnavailableMiriadDataSelectionError (const casacore::String &msg, casacore::Int win=0)
	An exception with a message. More...

	UnavailableMiriadDataSelectionError (const casacore::String &msg, const casacore::String &sel)
	An exception with a message. More...

virtual	~UnavailableMiriadDataSelectionError () throw ()

Public Member Functions inherited from casacore::AipsError
virtual const char *	what () const noexcept
	Simply returns the stored error message. More...

const String &	getMesg () const

String	getStackTrace () const

AipsError::Category	getCategory () const

void	setMessage (const String &msg) const
	Append a message. More...

	AipsError (const Char *str, Category c=GENERAL)
	Creates an AipsError and initializes the error message from the parameter. More...

	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. More...

Protected Member Functions
	UnavailableMiriadDataSelectionError ()
	Message-less exceptions should not be created excepted possibly by subclasses. More...

Protected Member Functions inherited from casacore::AipsError
void	addStackTrace ()
	Add the stack trace to the message (if USE_STACKTRACE is set). More...

Static Protected Member Functions
static casacore::String	makeMsg (const casacore::String &msg, casacore::Int selval=0)
	format a message from a string and the illegal integer selection. More...

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. More...

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. More...

static void	throwIf (Bool condition, const String &message, const char file, Int line, const char func="")
	Throw if the condition is true. More...

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. More...

Protected Attributes inherited from casacore::AipsError
String	message

Category	category

String	stackTrace

Detailed Description

an exception indicating that a requested data selection from a Miriad dataset is not available.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Synopsis

This class can be thrown as an exception to indicate that a requested data selection from a Miriad dataset is not available, usually because the selection is out of the bounds of the dataset's contents.

Example

if (win > maxwin || win <= 0) 
throw UnavailableMiriadDataSelectionError("No such window", win);
}

Motivation

Users can potentially make illegal data selection requests.

Definition at line 66 of file MirExceptions.h.

Constructor & Destructor Documentation

UnavailableMiriadDataSelectionError::UnavailableMiriadDataSelectionError	(	const casacore::String &	msg,
		casacore::Int	win = `0`
	)

An exception with a message.

win usually is a window number.

UnavailableMiriadDataSelectionError::UnavailableMiriadDataSelectionError	(	const casacore::String &	msg,
		const casacore::String &	sel
	)

An exception with a message.

sel is the data selection value (e.g. requested source name).

virtual UnavailableMiriadDataSelectionError::~UnavailableMiriadDataSelectionError	(	)
throw	(
	)

virtual

UnavailableMiriadDataSelectionError::UnavailableMiriadDataSelectionError ( )

protected

Message-less exceptions should not be created excepted possibly by subclasses.

Member Function Documentation

static casacore::String UnavailableMiriadDataSelectionError::makeMsg	(	const casacore::String &	msg,
		casacore::Int	selval = `0`
	)

staticprotected

format a message from a string and the illegal integer selection.

This class is used as a convenience for the instantiating the parent class, casacore::AipsError, which can only take a simple String.

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

casa/code/miriad/Filling/MirExceptions.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members