CDopplerReferenceCode Class Reference

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

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

Static Public Attributes
static const std::string &	sRADIO
	Enumerators as strings. More...
static const std::string &	sZ
static const std::string &	sRATIO
static const std::string &	sBETA
static const std::string &	sGAMMA
static const std::string &	sOPTICAL
static const std::string &	sRELATIVISTIC

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

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

Definition at line 95 of file CDopplerReferenceCode.h.

Constructor & Destructor Documentation

CDopplerReferenceCode::CDopplerReferenceCode ( )

private

CDopplerReferenceCode::CDopplerReferenceCode ( const CDopplerReferenceCode &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static DopplerReferenceCodeMod::DopplerReferenceCode CDopplerReferenceCode::from_int ( unsigned int  i )

static

Return a DopplerReferenceCode's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in DopplerReferenceCodeMod::DopplerReferenceCode.

Returns

a DopplerReferenceCodeMod::DopplerReferenceCode's enumerator.

Exceptions

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

static DopplerReferenceCodeMod::DopplerReferenceCode CDopplerReferenceCode::literal ( const std::string &  name )

static

Return a DopplerReferenceCode's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a DopplerReferenceCodeMod::DopplerReferenceCode's enumerator.

Exceptions

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

static std::string CDopplerReferenceCode::name ( const DopplerReferenceCodeMod::DopplerReferenceCode &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of DopplerReferenceCodeMod::DopplerReferenceCode.

Returns

a string.

static const std::vector<std::string> CDopplerReferenceCode::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 DopplerReferenceCodeMod::DopplerReferenceCode CDopplerReferenceCode::newDopplerReferenceCode ( const std::string &  name )

static

Create a DopplerReferenceCode enumeration object by specifying its name.

CDopplerReferenceCode& CDopplerReferenceCode::operator= ( const CDopplerReferenceCode &  )

private

static std::string CDopplerReferenceCode::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CDopplerReferenceCode::size ( )

static

Return the number of enumerators declared in DopplerReferenceCodeMod::DopplerReferenceCode.

Returns

an unsigned int.

static std::string CDopplerReferenceCode::toString ( const DopplerReferenceCodeMod::DopplerReferenceCode &  f )

inlinestatic

Equivalent to the name method.

Definition at line 149 of file CDopplerReferenceCode.h.

static int CDopplerReferenceCode::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CDopplerReferenceCode::sBETA

static

A const string equal to "BETA".

Definition at line 108 of file CDopplerReferenceCode.h.

const std::string& CDopplerReferenceCode::sGAMMA

static

A const string equal to "GAMMA".

Definition at line 110 of file CDopplerReferenceCode.h.

const std::string& CDopplerReferenceCode::sOPTICAL

static

A const string equal to "OPTICAL".

Definition at line 112 of file CDopplerReferenceCode.h.

const std::string& CDopplerReferenceCode::sRADIO

static

Enumerators as strings.

A const string equal to "RADIO".

Definition at line 102 of file CDopplerReferenceCode.h.

const std::string& CDopplerReferenceCode::sRATIO

static

A const string equal to "RATIO".

Definition at line 106 of file CDopplerReferenceCode.h.

const std::string& CDopplerReferenceCode::sRELATIVISTIC

static

A const string equal to "RELATIVISTIC".

Definition at line 114 of file CDopplerReferenceCode.h.

const std::string& CDopplerReferenceCode::sZ

static

A const string equal to "Z".

Definition at line 104 of file CDopplerReferenceCode.h.

---

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

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