casacore
Public Member Functions | Private Attributes | List of all members
casacore::ArrayIndexError Class Reference

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

#include <ArrayError.h>

Public Member Functions

 ArrayIndexError ()
 Initialize with the message "ArrayIndexError". More...
 
 ArrayIndexError (const char *m)
 Initialize with the supplied message, the index and shape are null. More...
 
 ArrayIndexError (const std::string &m)
 Initialize with the supplied message, the index and shape are null. More...
 
 ArrayIndexError (const IPosition &index, const IPosition &shape, const char *m="ArrayIndexError")
 Initialize with a given out-of-bounds index, as well as the shape of the array and a supplied message. More...
 
 ~ArrayIndexError () noexcept
 
IPosition index () const
 The out-of-bounds index. More...
 
IPosition shape () const
 The shape of the violated array. More...
 
- Public Member Functions inherited from casacore::ArrayError
 ArrayError ()
 Initialize with the message "ArrayError". More...
 
 ArrayError (const char *m)
 Initialize with the supplied message. More...
 
 ArrayError (const std::string &m)
 Initialize with the supplied message. More...
 
 ~ArrayError () noexcept
 

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

◆ ArrayIndexError() [1/4]

casacore::ArrayIndexError::ArrayIndexError ( )

Initialize with the message "ArrayIndexError".

◆ ArrayIndexError() [2/4]

casacore::ArrayIndexError::ArrayIndexError ( const char *  m)

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

◆ ArrayIndexError() [3/4]

casacore::ArrayIndexError::ArrayIndexError ( const std::string &  m)

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

◆ ArrayIndexError() [4/4]

casacore::ArrayIndexError::ArrayIndexError ( const IPosition index,
const IPosition shape,
const char *  m = "ArrayIndexError" 
)

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

◆ ~ArrayIndexError()

casacore::ArrayIndexError::~ArrayIndexError ( )
noexcept

Member Function Documentation

◆ index()

IPosition casacore::ArrayIndexError::index ( ) const

The out-of-bounds index.

◆ shape()

IPosition casacore::ArrayIndexError::shape ( ) const

The shape of the violated array.

Member Data Documentation

◆ i

IPosition casacore::ArrayIndexError::i
private

Definition at line 101 of file ArrayError.h.

◆ l

IPosition casacore::ArrayIndexError::l
private

Definition at line 101 of file ArrayError.h.


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