casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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>

Inheritance diagram for casacore::ArrayIndexError:
casacore::ArrayError casacore::AipsError

Public Member Functions

 ArrayIndexError (Category c=BOUNDARY)
 Initialize with the message "ArrayIndexError". More...
 
 ArrayIndexError (const Char *m, Category c=BOUNDARY)
 Initialize with the supplied message, the index and shape are null. More...
 
 ArrayIndexError (const String &m, Category c=BOUNDARY)
 Initialize with the supplied message, the index and shape are null. More...
 
 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. 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 (Category c=GENERAL)
 Initialize with the message "ArrayError.". More...
 
 ArrayError (const Char *m, Category c=GENERAL)
 Initialize with the supplied message. More...
 
 ArrayError (const String &m, Category c=GENERAL)
 Initialize with the supplied message. More...
 
 ~ArrayError () noexcept
 
- Public Member Functions inherited from casacore::AipsError
virtual const char * what () const noexcept
 Simply returns the stored error message. More...
 
const StringgetMesg () 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...
 

Private Attributes

IPosition i
 
IPosition l
 

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 Member Functions inherited from casacore::AipsError
void addStackTrace ()
 Add the stack trace to the message (if USE_STACKTRACE is set). More...
 
- Protected Attributes inherited from casacore::AipsError
String message
 
Category category
 
String stackTrace
 

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 ( )
noexcept

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

Definition at line 101 of file ArrayError.h.


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