casacore::ArrayIndexError Class Reference

An error thrown when an index is out of range. More...

#include <ArrayError.h>

Inheritance diagram for casacore::ArrayIndexError:

Public Member Functions
	ArrayIndexError (Category c=BOUNDARY)
	Initialize with the message "ArrayIndexError".
	ArrayIndexError (const Char *m, Category c=BOUNDARY)
	Initialize with the supplied message, the index and shape are null.
	ArrayIndexError (const String &m, Category c=BOUNDARY)
	Initialize with the supplied message, the index and shape are null.
	ArrayIndexError (const IPosition &index, const IPosition &shape, const Char *m="ArrayIndexError", Category c=BOUNDARY)
	Initialize with a given out-of-bounds index, as well as the shape of the array and a supplied message.
	~ArrayIndexError () throw ()
IPosition	index () const
	The out-of-bounds index.
IPosition	shape () const
	The shape of the violated array.
Private Attributes
IPosition	i
IPosition	l

Detailed Description

An error thrown when an index is out of range.

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

The ArrayIndexError class, which is derived from ArrayError, is intended to be thrown when an index is out-of-bounds. It contains within it the offending index, as well as the shape of the array which is being indexed. This should be multiply-derived from indexError<T> defined in Error.h.

Definition at line 81 of file ArrayError.h.

Constructor & Destructor Documentation

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

Initialize with the message "ArrayIndexError".

casacore::ArrayIndexError::ArrayIndexError	(	const Char *	m,
		Category	c = `BOUNDARY`
	)

Initialize with the supplied message, the index and shape are null.

casacore::ArrayIndexError::ArrayIndexError	(	const String &	m,
		Category	c = `BOUNDARY`
	)

Initialize with the supplied message, the index and shape are null.

casacore::ArrayIndexError::ArrayIndexError	(	const IPosition &	index,
		const IPosition &	shape,
		const Char *	m = `"ArrayIndexError"`,
		Category	c = `BOUNDARY`
	)

Initialize with a given out-of-bounds index, as well as the shape of the array and a supplied message.

casacore::ArrayIndexError::~ArrayIndexError ( ) throw ()

Member Function Documentation

IPosition casacore::ArrayIndexError::index ( ) const

The out-of-bounds index.

IPosition casacore::ArrayIndexError::shape ( ) const

The shape of the violated array.

Member Data Documentation

IPosition casacore::ArrayIndexError::i [private]

Definition at line 101 of file ArrayError.h.

IPosition casacore::ArrayIndexError::l [private]