CCalibrationFunction Class Reference

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

#include <CCalibrationFunction.h>

List of all members.

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 CalibrationFunctionMod::CalibrationFunction.
static std::string	name (const CalibrationFunctionMod::CalibrationFunction &e)
	Returns an enumerator as a string.
static std::string	toString (const CalibrationFunctionMod::CalibrationFunction &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static CalibrationFunctionMod::CalibrationFunction	newCalibrationFunction (const std::string &name)
	Create a CalibrationFunction enumeration object by specifying its name.
static CalibrationFunctionMod::CalibrationFunction	literal (const std::string &name)
static CalibrationFunctionMod::CalibrationFunction	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sFIRST
	Enumerators as strings.
static const std::string &	sLAST
static const std::string &	sUNSPECIFIED
Private Member Functions
	CCalibrationFunction ()
	CCalibrationFunction (const CCalibrationFunction &)
CCalibrationFunction &	operator= (const CCalibrationFunction &)
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 CalibrationFunction.

Definition at line 85 of file CCalibrationFunction.h.

---

Constructor & Destructor Documentation

CCalibrationFunction::CCalibrationFunction

(

)

[private]

CCalibrationFunction::CCalibrationFunction

(

const CCalibrationFunction &

)

[private]

---

Member Function Documentation

static std::string CCalibrationFunction::badInt

(

unsigned int

i

)

[static, private]

static std::string CCalibrationFunction::badString

(

const std::string &

name

)

[static, private]

static CalibrationFunctionMod::CalibrationFunction CCalibrationFunction::from_int

(

unsigned int

i

)

[static]

Return a CalibrationFunction's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in CalibrationFunctionMod::CalibrationFunction.

Returns:

a CalibrationFunctionMod::CalibrationFunction's enumerator.

Exceptions:

a

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

static CalibrationFunctionMod::CalibrationFunction CCalibrationFunction::literal

(

const std::string &

name

)

[static]

Return a CalibrationFunction's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a CalibrationFunctionMod::CalibrationFunction's enumerator.

Exceptions:

a

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

static std::string CCalibrationFunction::name

(

const CalibrationFunctionMod::CalibrationFunction &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of CalibrationFunctionMod::CalibrationFunction.

Returns:

a string.

static const std::vector<std::string> CCalibrationFunction::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 CalibrationFunctionMod::CalibrationFunction CCalibrationFunction::newCalibrationFunction

(

const std::string &

name

)

[static]

Create a CalibrationFunction enumeration object by specifying its name.

CCalibrationFunction& CCalibrationFunction::operator=

(

const CCalibrationFunction &

)

[private]

static std::string CCalibrationFunction::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CCalibrationFunction::size

(

)

[static]

Return the number of enumerators declared in CalibrationFunctionMod::CalibrationFunction.

Returns:

an unsigned int.

static std::string CCalibrationFunction::toString

(

const CalibrationFunctionMod::CalibrationFunction &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 131 of file CCalibrationFunction.h.

static int CCalibrationFunction::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CCalibrationFunction::sFIRST [static]

Enumerators as strings.

A const string equal to "FIRST".

Definition at line 92 of file CCalibrationFunction.h.

const std::string& CCalibrationFunction::sLAST [static]

A const string equal to "LAST".

Definition at line 94 of file CCalibrationFunction.h.

const std::string& CCalibrationFunction::sUNSPECIFIED [static]

A const string equal to "UNSPECIFIED".

Definition at line 96 of file CCalibrationFunction.h.

---

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

• code/alma/Enumerations/CCalibrationFunction.h