casacore
Public Member Functions | Protected Attributes | List of all members
casacore::indexError< t > Class Template Reference

Index errors returning the bad index. More...

#include <Error.h>

Public Member Functions

 indexError (t oI, const Char *str, Category c=BOUNDARY)
 This constructor takes the error message and the index which cause the error to occur. More...
 
 indexError (t oI, const String &str, Category c=BOUNDARY)
 
 indexError (t oI, Category c=BOUNDARY)
 
 ~indexError () noexcept
 Destructor which does nothing. More...
 
- Public Member Functions inherited from casacore::IndexError
 IndexError (const Char *str, Category c=BOUNDARY)
 Creates an GeneralIndexError and initializes the error message from the parameter. More...
 
 IndexError (const String &str, Category c=BOUNDARY)
 
 IndexError (Category c=BOUNDARY)
 
 ~IndexError () noexcept
 Destructor which does nothing. More...
 
- 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...
 

Protected Attributes

oIndex
 
- Protected Attributes inherited from casacore::AipsError
String message
 
Category category
 
String stackTrace
 

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

Detailed Description

template<class t>
class casacore::indexError< t >

Index errors returning the bad index.

Intended use:

Public interface

Review Status

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

Synopsis

This class is templated to allow generalalized indexes to be returned with the error message i.e. the class is templated on the index type.

Example

throw(indexError<int>(3,"ANY STRING"));/

Definition at line 319 of file Error.h.

Constructor & Destructor Documentation

◆ indexError() [1/3]

template<class t >
casacore::indexError< t >::indexError ( oI,
const Char str,
Category  c = BOUNDARY 
)

This constructor takes the error message and the index which cause the error to occur.

◆ indexError() [2/3]

template<class t >
casacore::indexError< t >::indexError ( oI,
const String str,
Category  c = BOUNDARY 
)

◆ indexError() [3/3]

template<class t >
casacore::indexError< t >::indexError ( oI,
Category  c = BOUNDARY 
)
inline

Definition at line 330 of file Error.h.

◆ ~indexError()

template<class t >
casacore::indexError< t >::~indexError ( )
noexcept

Destructor which does nothing.

Member Data Documentation

◆ oIndex

template<class t >
t casacore::indexError< t >::oIndex
protected

Definition at line 321 of file Error.h.


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