CFluxCalibrationMethod Class Reference

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

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

Static Public Attributes
static const std::string &	sABSOLUTE
	Enumerators as strings. More...
static const std::string &	sRELATIVE
static const std::string &	sEFFICIENCY

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

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

Definition at line 85 of file CFluxCalibrationMethod.h.

Constructor & Destructor Documentation

CFluxCalibrationMethod::CFluxCalibrationMethod ( )

private

CFluxCalibrationMethod::CFluxCalibrationMethod ( const CFluxCalibrationMethod &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static FluxCalibrationMethodMod::FluxCalibrationMethod CFluxCalibrationMethod::from_int ( unsigned int  i )

static

Return a FluxCalibrationMethod's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in FluxCalibrationMethodMod::FluxCalibrationMethod.

Returns

a FluxCalibrationMethodMod::FluxCalibrationMethod's enumerator.

Exceptions

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

static FluxCalibrationMethodMod::FluxCalibrationMethod CFluxCalibrationMethod::literal ( const std::string &  name )

static

Return a FluxCalibrationMethod's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a FluxCalibrationMethodMod::FluxCalibrationMethod's enumerator.

Exceptions

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

static std::string CFluxCalibrationMethod::name ( const FluxCalibrationMethodMod::FluxCalibrationMethod &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of FluxCalibrationMethodMod::FluxCalibrationMethod.

Returns

a string.

static const std::vector<std::string> CFluxCalibrationMethod::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 FluxCalibrationMethodMod::FluxCalibrationMethod CFluxCalibrationMethod::newFluxCalibrationMethod ( const std::string &  name )

static

Create a FluxCalibrationMethod enumeration object by specifying its name.

CFluxCalibrationMethod& CFluxCalibrationMethod::operator= ( const CFluxCalibrationMethod &  )

private

static std::string CFluxCalibrationMethod::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CFluxCalibrationMethod::size ( )

static

Return the number of enumerators declared in FluxCalibrationMethodMod::FluxCalibrationMethod.

Returns

an unsigned int.

static std::string CFluxCalibrationMethod::toString ( const FluxCalibrationMethodMod::FluxCalibrationMethod &  f )

inlinestatic

Equivalent to the name method.

Definition at line 131 of file CFluxCalibrationMethod.h.

static int CFluxCalibrationMethod::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CFluxCalibrationMethod::sABSOLUTE

static

Enumerators as strings.

A const string equal to "ABSOLUTE".

Definition at line 92 of file CFluxCalibrationMethod.h.

const std::string& CFluxCalibrationMethod::sEFFICIENCY

static

A const string equal to "EFFICIENCY".

Definition at line 96 of file CFluxCalibrationMethod.h.

const std::string& CFluxCalibrationMethod::sRELATIVE

static

A const string equal to "RELATIVE".

Definition at line 94 of file CFluxCalibrationMethod.h.

---

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

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