casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Static Public Member Functions | List of all members
casacore::Quality Class Reference

Quality parameter definitions. More...

#include <Quality.h>

Public Types

enum  QualityTypes {
  Undefined,
  DATA,
  ERROR
}
 
enum  { NumberOfTypes }
 The number of QualityTypes. More...
 

Static Public Member Functions

static QualityTypes type (Int qualityNumber)
 Convert Int to QualityTypes, returns Quality::Undefined if it is an invalid type. More...
 
static QualityTypes type (const String &quality)
 Convert String to QualityTypes, returns Quality::Undefined if it is an unrecognized string. More...
 
static String name (QualityTypes qualityType)
 Convert QualityTypes to String, Quality::Undefined returns "??". More...
 
static Vector< StringallNames (Bool includeUndefined=False)
 Get all recognized quality names in no guaranteed order. More...
 

Detailed Description

Quality parameter definitions.

Review Status

Test programs:
tQuality

Synopsis

This enumerates the available Quality types. This class is a wrapper for the ENUM and conversion functions. All methods are static.

Definition at line 49 of file Quality.h.

Member Enumeration Documentation

anonymous enum

The number of QualityTypes.


Warning: Update NumberOfTypes when entries are added;

Enumerator
NumberOfTypes 

The number of QualityTypes.

Definition at line 70 of file Quality.h.

Enumerator
Undefined 

undefined value = 0

DATA 

the data type

ERROR 

the error type

Definition at line 54 of file Quality.h.

Member Function Documentation

static Vector<String> casacore::Quality::allNames ( Bool  includeUndefined = False)
static

Get all recognized quality names in no guaranteed order.

The undefined type can be included.

static String casacore::Quality::name ( QualityTypes  qualityType)
static

Convert QualityTypes to String, Quality::Undefined returns "??".

static QualityTypes casacore::Quality::type ( Int  qualityNumber)
static

Convert Int to QualityTypes, returns Quality::Undefined if it is an invalid type.

static QualityTypes casacore::Quality::type ( const String quality)
static

Convert String to QualityTypes, returns Quality::Undefined if it is an unrecognized string.

The valid strings are the same as the characters used in the enum above (i.e. "DATA" returns Quality::DATA, "ERROR" returns Quality::ERROR, etc).


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