UnavailableMiriadDataSelectionError Class Reference

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

#include <MirExceptions.h>

Public Member Functions
	UnavailableMiriadDataSelectionError (const String &msg, Int win=0)
	An exception with a message.
	UnavailableMiriadDataSelectionError (const String &msg, const String &sel)
	An exception with a message.
virtual	~UnavailableMiriadDataSelectionError () throw ()
Protected Member Functions
	UnavailableMiriadDataSelectionError ()
	Message-less exceptions should not be created excepted possibly by subclasses.
Static Protected Member Functions
static String	makeMsg (const String &msg, Int selval=0)
	format a message from a string and the illegal integer selection.

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 String &	msg,
		Int	win = `0`
	)

An exception with a message.

win usually is a window number.

UnavailableMiriadDataSelectionError::UnavailableMiriadDataSelectionError	(	const String &	msg,
		const 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 String UnavailableMiriadDataSelectionError::makeMsg	(	const String &	msg,
		Int	selval = `0`
	)			`[static, protected]`

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

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

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

code/miriad/Filling/MirExceptions.h