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::ArrayShapeError Class Reference

An error thrown when two arrays have different shapes. More...

#include <ArrayError.h>

Inheritance diagram for casacore::ArrayShapeError:
casacore::ArrayConformanceError casacore::ArrayError casacore::AipsError

Public Member Functions

 ArrayShapeError (const IPosition &shape1, const IPosition &shape2, const Char *m="ArrayShapeError", Category c=CONFORMANCE)
 Define an ArrayShapeError with the two (presumably different) shapes and an optional supplied message. More...
 
 ~ArrayShapeError () noexcept
 
void shapes (IPosition &, IPosition &) const
 Get back the stored shapes. More...
 
- Public Member Functions inherited from casacore::ArrayConformanceError
 ArrayConformanceError (Category c=CONFORMANCE)
 Initialize the message with "ArrayConformanceError". More...
 
 ArrayConformanceError (const Char *m, Category c=CONFORMANCE)
 Initialize with a supplied message. More...
 
 ArrayConformanceError (const String &m, Category c=CONFORMANCE)
 Initialize with a supplied message. More...
 
 ~ArrayConformanceError () noexcept
 
- 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 sh1
 
IPosition sh2
 

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 two arrays have different shapes.

Review Status

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

An ArrayShapeError is derived from ArrayConformanceError. It is thrown when two arrays are non-conformant by virtue of having different shapes. It holds within it the two different two shapes.

Definition at line 155 of file ArrayError.h.

Constructor & Destructor Documentation

casacore::ArrayShapeError::ArrayShapeError ( const IPosition shape1,
const IPosition shape2,
const Char m = "ArrayShapeError",
Category  c = CONFORMANCE 
)

Define an ArrayShapeError with the two (presumably different) shapes and an optional supplied message.

casacore::ArrayShapeError::~ArrayShapeError ( )
noexcept

Member Function Documentation

void casacore::ArrayShapeError::shapes ( IPosition ,
IPosition  
) const

Get back the stored shapes.

NB modifies arguments.

Member Data Documentation

IPosition casacore::ArrayShapeError::sh1
private

Definition at line 166 of file ArrayError.h.

IPosition casacore::ArrayShapeError::sh2
private

Definition at line 166 of file ArrayError.h.


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