casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
MiriadFormatError Class Reference

an exception indicating that a non-recoverable format error was detected in the input Miriad dataset More...

#include <MirExceptions.h>

Inheritance diagram for MiriadFormatError:
casacore::AipsError

Public Member Functions

 MiriadFormatError (const casacore::String &msg)
 create the exception with a message describing the format error More...
 
virtual ~MiriadFormatError () throw ()
 
- 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 Member Functions

 MiriadFormatError ()
 Message-less exceptions should not be created excepted possibly by subclasses. More...
 
- Protected Member Functions inherited from casacore::AipsError
void addStackTrace ()
 Add the stack trace to the message (if USE_STACKTRACE is set). More...
 

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 Attributes inherited from casacore::AipsError
String message
 
Category category
 
String stackTrace
 

Detailed Description

an exception indicating that a non-recoverable format error was detected in the input Miriad dataset

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Synopsis

This exception can be thrown when a Miriad dataset contains some unexpected and/or illegal structures. This may happen if the dataset is corrupted or otherwise does not conform to the legal format specification.

Example

uvprobvr_c(mirds_handle, "sfreq", vtype, &vlen, &vupd);
if (vlen != nspect) {
throw MiriadFormatError(casacore::String("Wrong number of values for variable ") +
"sfreq: got " + vlen + "; expected " + nspect);
}

Motivation

This class handles the possibility that a non-conforming or corrupted Miriad dataset is encountered.

Definition at line 121 of file MirExceptions.h.

Constructor & Destructor Documentation

MiriadFormatError::MiriadFormatError ( const casacore::String msg)

create the exception with a message describing the format error

virtual MiriadFormatError::~MiriadFormatError ( )
throw (
)
virtual
MiriadFormatError::MiriadFormatError ( )
protected

Message-less exceptions should not be created excepted possibly by subclasses.


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