CCorrelatorName Class Reference

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

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

Static Public Attributes
static const std::string &	sALMA_ACA
	Enumerators as strings. More...
static const std::string &	sALMA_BASELINE
static const std::string &	sALMA_BASELINE_ATF
static const std::string &	sALMA_BASELINE_PROTO_OSF
static const std::string &	sHERSCHEL
static const std::string &	sIRAM_PDB
static const std::string &	sIRAM_30M_VESPA
static const std::string &	sIRAM_WILMA
static const std::string &	sNRAO_VLA
static const std::string &	sNRAO_WIDAR

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

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

Definition at line 99 of file CCorrelatorName.h.

Constructor & Destructor Documentation

CCorrelatorName::CCorrelatorName ( )

private

CCorrelatorName::CCorrelatorName ( const CCorrelatorName &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static CorrelatorNameMod::CorrelatorName CCorrelatorName::from_int ( unsigned int  i )

static

Return a CorrelatorName's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in CorrelatorNameMod::CorrelatorName.

Returns

a CorrelatorNameMod::CorrelatorName's enumerator.

Exceptions

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

static CorrelatorNameMod::CorrelatorName CCorrelatorName::literal ( const std::string &  name )

static

Return a CorrelatorName's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a CorrelatorNameMod::CorrelatorName's enumerator.

Exceptions

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

static std::string CCorrelatorName::name ( const CorrelatorNameMod::CorrelatorName &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of CorrelatorNameMod::CorrelatorName.

Returns

a string.

static const std::vector<std::string> CCorrelatorName::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 CorrelatorNameMod::CorrelatorName CCorrelatorName::newCorrelatorName ( const std::string &  name )

static

Create a CorrelatorName enumeration object by specifying its name.

CCorrelatorName& CCorrelatorName::operator= ( const CCorrelatorName &  )

private

static std::string CCorrelatorName::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CCorrelatorName::size ( )

static

Return the number of enumerators declared in CorrelatorNameMod::CorrelatorName.

Returns

an unsigned int.

static std::string CCorrelatorName::toString ( const CorrelatorNameMod::CorrelatorName &  f )

inlinestatic

Equivalent to the name method.

Definition at line 159 of file CCorrelatorName.h.

static int CCorrelatorName::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CCorrelatorName::sALMA_ACA

static

Enumerators as strings.

A const string equal to "ALMA_ACA".

Definition at line 106 of file CCorrelatorName.h.

const std::string& CCorrelatorName::sALMA_BASELINE

static

A const string equal to "ALMA_BASELINE".

Definition at line 108 of file CCorrelatorName.h.

const std::string& CCorrelatorName::sALMA_BASELINE_ATF

static

A const string equal to "ALMA_BASELINE_ATF".

Definition at line 110 of file CCorrelatorName.h.

const std::string& CCorrelatorName::sALMA_BASELINE_PROTO_OSF

static

A const string equal to "ALMA_BASELINE_PROTO_OSF".

Definition at line 112 of file CCorrelatorName.h.

const std::string& CCorrelatorName::sHERSCHEL

static

A const string equal to "HERSCHEL".

Definition at line 114 of file CCorrelatorName.h.

const std::string& CCorrelatorName::sIRAM_30M_VESPA

static

A const string equal to "IRAM_30M_VESPA".

Definition at line 118 of file CCorrelatorName.h.

const std::string& CCorrelatorName::sIRAM_PDB

static

A const string equal to "IRAM_PDB".

Definition at line 116 of file CCorrelatorName.h.

const std::string& CCorrelatorName::sIRAM_WILMA

static

A const string equal to "IRAM_WILMA".

Definition at line 120 of file CCorrelatorName.h.

const std::string& CCorrelatorName::sNRAO_VLA

static

A const string equal to "NRAO_VLA".

Definition at line 122 of file CCorrelatorName.h.

const std::string& CCorrelatorName::sNRAO_WIDAR

static

A const string equal to "NRAO_WIDAR".

Definition at line 124 of file CCorrelatorName.h.

---

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

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