CAtmPhaseCorrection Class Reference

A helper class for the enumeration AtmPhaseCorrection. More...

#include <CAtmPhaseCorrection.h>

Static Public Member Functions
static int	version ()
	Return the major version number as an int. More...
static std::string	revision ()
	Return the revision as a string. More...
static unsigned int	size ()
	Return the number of enumerators declared in AtmPhaseCorrectionMod::AtmPhaseCorrection. More...
static std::string	name (const AtmPhaseCorrectionMod::AtmPhaseCorrection &e)
	Returns an enumerator as a string. More...
static std::string	toString (const AtmPhaseCorrectionMod::AtmPhaseCorrection &f)
	Equivalent to the name method. More...
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings. More...
static AtmPhaseCorrectionMod::AtmPhaseCorrection	newAtmPhaseCorrection (const std::string &name)
	Create a AtmPhaseCorrection enumeration object by specifying its name. More...
static AtmPhaseCorrectionMod::AtmPhaseCorrection	literal (const std::string &name)
static AtmPhaseCorrectionMod::AtmPhaseCorrection	from_int (unsigned int i)

Static Public Attributes
static const std::string &	sAP_UNCORRECTED
	Enumerators as strings. More...
static const std::string &	sAP_CORRECTED

Private Member Functions
	CAtmPhaseCorrection ()
	CAtmPhaseCorrection (const CAtmPhaseCorrection &)
CAtmPhaseCorrection &	operator= (const CAtmPhaseCorrection &)

Static Private Member Functions
static std::string	badString (const std::string &name)
static std::string	badInt (unsigned int i)

Detailed Description

A helper class for the enumeration AtmPhaseCorrection.

Definition at line 83 of file CAtmPhaseCorrection.h.

Constructor & Destructor Documentation

CAtmPhaseCorrection::CAtmPhaseCorrection ( )

private

CAtmPhaseCorrection::CAtmPhaseCorrection ( const CAtmPhaseCorrection &  )

private

Member Function Documentation

static std::string CAtmPhaseCorrection::badInt ( unsigned int  i )

staticprivate

static std::string CAtmPhaseCorrection::badString ( const std::string &  name )

staticprivate

static AtmPhaseCorrectionMod::AtmPhaseCorrection CAtmPhaseCorrection::from_int ( unsigned int  i )

static

Return a AtmPhaseCorrection's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in AtmPhaseCorrectionMod::AtmPhaseCorrection.

Returns

a AtmPhaseCorrectionMod::AtmPhaseCorrection's enumerator.

Exceptions

a	string containing an error message if no enumerator could be found for this integer.

static AtmPhaseCorrectionMod::AtmPhaseCorrection CAtmPhaseCorrection::literal ( const std::string &  name )

static

Return a AtmPhaseCorrection's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a AtmPhaseCorrectionMod::AtmPhaseCorrection's enumerator.

Exceptions

a	string containing an error message if no enumerator could be found for this name.

static std::string CAtmPhaseCorrection::name ( const AtmPhaseCorrectionMod::AtmPhaseCorrection &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of AtmPhaseCorrectionMod::AtmPhaseCorrection.

Returns

a string.

static const std::vector<std::string> CAtmPhaseCorrection::names ( )

static

Returns vector of all the enumerators as strings.

The strings are stored in the vector in the same order than the enumerators are declared in the enumeration.

Returns

a vector of string.

static AtmPhaseCorrectionMod::AtmPhaseCorrection CAtmPhaseCorrection::newAtmPhaseCorrection ( const std::string &  name )

static

Create a AtmPhaseCorrection enumeration object by specifying its name.

CAtmPhaseCorrection& CAtmPhaseCorrection::operator= ( const CAtmPhaseCorrection &  )

private

static std::string CAtmPhaseCorrection::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CAtmPhaseCorrection::size ( )

static

Return the number of enumerators declared in AtmPhaseCorrectionMod::AtmPhaseCorrection.

Returns

an unsigned int.

static std::string CAtmPhaseCorrection::toString ( const AtmPhaseCorrectionMod::AtmPhaseCorrection &  f )

inlinestatic

Equivalent to the name method.

Definition at line 127 of file CAtmPhaseCorrection.h.

static int CAtmPhaseCorrection::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CAtmPhaseCorrection::sAP_CORRECTED

static

A const string equal to "AP_CORRECTED".

Definition at line 92 of file CAtmPhaseCorrection.h.

const std::string& CAtmPhaseCorrection::sAP_UNCORRECTED

static

Enumerators as strings.

A const string equal to "AP_UNCORRECTED".

Definition at line 90 of file CAtmPhaseCorrection.h.

---

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

• casa/code/alma/Enumerations/CAtmPhaseCorrection.h