CFrequencyReferenceCode Class Reference

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

#include <CFrequencyReferenceCode.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 FrequencyReferenceCodeMod::FrequencyReferenceCode. More...
static std::string	name (const FrequencyReferenceCodeMod::FrequencyReferenceCode &e)
	Returns an enumerator as a string. More...
static std::string	toString (const FrequencyReferenceCodeMod::FrequencyReferenceCode &f)
	Equivalent to the name method. More...
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings. More...
static FrequencyReferenceCodeMod::FrequencyReferenceCode	newFrequencyReferenceCode (const std::string &name)
	Create a FrequencyReferenceCode enumeration object by specifying its name. More...
static FrequencyReferenceCodeMod::FrequencyReferenceCode	literal (const std::string &name)
static FrequencyReferenceCodeMod::FrequencyReferenceCode	from_int (unsigned int i)

Static Public Attributes
static const std::string &	sLABREST
	Enumerators as strings. More...
static const std::string &	sLSRD
static const std::string &	sLSRK
static const std::string &	sBARY
static const std::string &	sREST
static const std::string &	sGEO
static const std::string &	sGALACTO
static const std::string &	sTOPO

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

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

Definition at line 95 of file CFrequencyReferenceCode.h.

Constructor & Destructor Documentation

CFrequencyReferenceCode::CFrequencyReferenceCode ( )

private

CFrequencyReferenceCode::CFrequencyReferenceCode ( const CFrequencyReferenceCode &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static FrequencyReferenceCodeMod::FrequencyReferenceCode CFrequencyReferenceCode::from_int ( unsigned int  i )

static

Return a FrequencyReferenceCode's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in FrequencyReferenceCodeMod::FrequencyReferenceCode.

Returns

a FrequencyReferenceCodeMod::FrequencyReferenceCode's enumerator.

Exceptions

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

static FrequencyReferenceCodeMod::FrequencyReferenceCode CFrequencyReferenceCode::literal ( const std::string &  name )

static

Return a FrequencyReferenceCode's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a FrequencyReferenceCodeMod::FrequencyReferenceCode's enumerator.

Exceptions

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

static std::string CFrequencyReferenceCode::name ( const FrequencyReferenceCodeMod::FrequencyReferenceCode &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of FrequencyReferenceCodeMod::FrequencyReferenceCode.

Returns

a string.

static const std::vector<std::string> CFrequencyReferenceCode::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 FrequencyReferenceCodeMod::FrequencyReferenceCode CFrequencyReferenceCode::newFrequencyReferenceCode ( const std::string &  name )

static

Create a FrequencyReferenceCode enumeration object by specifying its name.

CFrequencyReferenceCode& CFrequencyReferenceCode::operator= ( const CFrequencyReferenceCode &  )

private

static std::string CFrequencyReferenceCode::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CFrequencyReferenceCode::size ( )

static

Return the number of enumerators declared in FrequencyReferenceCodeMod::FrequencyReferenceCode.

Returns

an unsigned int.

static std::string CFrequencyReferenceCode::toString ( const FrequencyReferenceCodeMod::FrequencyReferenceCode &  f )

inlinestatic

Equivalent to the name method.

Definition at line 151 of file CFrequencyReferenceCode.h.

static int CFrequencyReferenceCode::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CFrequencyReferenceCode::sBARY

static

A const string equal to "BARY".

Definition at line 108 of file CFrequencyReferenceCode.h.

const std::string& CFrequencyReferenceCode::sGALACTO

static

A const string equal to "GALACTO".

Definition at line 114 of file CFrequencyReferenceCode.h.

const std::string& CFrequencyReferenceCode::sGEO

static

A const string equal to "GEO".

Definition at line 112 of file CFrequencyReferenceCode.h.

const std::string& CFrequencyReferenceCode::sLABREST

static

Enumerators as strings.

A const string equal to "LABREST".

Definition at line 102 of file CFrequencyReferenceCode.h.

const std::string& CFrequencyReferenceCode::sLSRD

static

A const string equal to "LSRD".

Definition at line 104 of file CFrequencyReferenceCode.h.

const std::string& CFrequencyReferenceCode::sLSRK

static

A const string equal to "LSRK".

Definition at line 106 of file CFrequencyReferenceCode.h.

const std::string& CFrequencyReferenceCode::sREST

static

A const string equal to "REST".

Definition at line 110 of file CFrequencyReferenceCode.h.

const std::string& CFrequencyReferenceCode::sTOPO

static

A const string equal to "TOPO".

Definition at line 116 of file CFrequencyReferenceCode.h.

---

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

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