CRadialVelocityReferenceCode Class Reference

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

#include <CRadialVelocityReferenceCode.h>

Static Public Member Functions
static int	version ()
	Return the major version number as an int.
static std::string	revision ()
	Return the revision as a string.
static unsigned int	size ()
	Return the number of enumerators declared in RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode.
static std::string	name (const RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode &e)
	Returns an enumerator as a string.
static std::string	toString (const RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode	newRadialVelocityReferenceCode (const std::string &name)
	Create a RadialVelocityReferenceCode enumeration object by specifying its name.
static RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode	literal (const std::string &name)
static RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sLSRD
	Enumerators as strings.
static const std::string &	sLSRK
static const std::string &	sGALACTO
static const std::string &	sBARY
static const std::string &	sGEO
static const std::string &	sTOPO
Private Member Functions
	CRadialVelocityReferenceCode ()
	CRadialVelocityReferenceCode (const CRadialVelocityReferenceCode &)
CRadialVelocityReferenceCode &	operator= (const CRadialVelocityReferenceCode &)
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 RadialVelocityReferenceCode.

Definition at line 91 of file CRadialVelocityReferenceCode.h.

Constructor & Destructor Documentation

CRadialVelocityReferenceCode::CRadialVelocityReferenceCode ( ) [private]

CRadialVelocityReferenceCode::CRadialVelocityReferenceCode ( const CRadialVelocityReferenceCode & ) [private]

Member Function Documentation

static std::string CRadialVelocityReferenceCode::badInt ( unsigned int i ) [static, private]

static std::string CRadialVelocityReferenceCode::badString ( const std::string & name ) [static, private]

static RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode CRadialVelocityReferenceCode::from_int ( unsigned int i ) [static]

Return a RadialVelocityReferenceCode's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode.

Returns:: a RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode's enumerator.

Exceptions:

a

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

static RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode CRadialVelocityReferenceCode::literal ( const std::string & name ) [static]

Return a RadialVelocityReferenceCode's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:: a RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode's enumerator.

Exceptions:

a

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

static std::string CRadialVelocityReferenceCode::name ( const RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode & e ) [static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode.

Returns:: a string.

static const std::vector<std::string> CRadialVelocityReferenceCode::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 RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode CRadialVelocityReferenceCode::newRadialVelocityReferenceCode ( const std::string & name ) [static]

Create a RadialVelocityReferenceCode enumeration object by specifying its name.

CRadialVelocityReferenceCode& CRadialVelocityReferenceCode::operator= ( const CRadialVelocityReferenceCode & ) [private]

static std::string CRadialVelocityReferenceCode::revision ( ) [static]

Return the revision as a string.

Returns:: a string

static unsigned int CRadialVelocityReferenceCode::size ( ) [static]

Return the number of enumerators declared in RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode.

Returns:: an unsigned int.

static std::string CRadialVelocityReferenceCode::toString ( const RadialVelocityReferenceCodeMod::RadialVelocityReferenceCode & f ) [inline, static]

Equivalent to the name method.

Definition at line 143 of file CRadialVelocityReferenceCode.h.

static int CRadialVelocityReferenceCode::version ( ) [static]

Return the major version number as an int.