CCalibrationMode Class Reference

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

#include <CCalibrationMode.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 CalibrationModeMod::CalibrationMode.
static std::string	name (const CalibrationModeMod::CalibrationMode &e)
	Returns an enumerator as a string.
static std::string	toString (const CalibrationModeMod::CalibrationMode &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static CalibrationModeMod::CalibrationMode	newCalibrationMode (const std::string &name)
	Create a CalibrationMode enumeration object by specifying its name.
static CalibrationModeMod::CalibrationMode	literal (const std::string &name)
static CalibrationModeMod::CalibrationMode	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sHOLOGRAPHY
	Enumerators as strings.
static const std::string &	sINTERFEROMETRY
static const std::string &	sOPTICAL
static const std::string &	sRADIOMETRY
static const std::string &	sWVR
Private Member Functions
	CCalibrationMode ()
	CCalibrationMode (const CCalibrationMode &)
CCalibrationMode &	operator= (const CCalibrationMode &)
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 CalibrationMode.

Definition at line 89 of file CCalibrationMode.h.

---

Constructor & Destructor Documentation

CCalibrationMode::CCalibrationMode

(

)

[private]

CCalibrationMode::CCalibrationMode

(

const CCalibrationMode &

)

[private]

---

Member Function Documentation

static std::string CCalibrationMode::badInt

(

unsigned int

i

)

[static, private]

static std::string CCalibrationMode::badString

(

const std::string &

name

)

[static, private]

static CalibrationModeMod::CalibrationMode CCalibrationMode::from_int

(

unsigned int

i

)

[static]

Return a CalibrationMode's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in CalibrationModeMod::CalibrationMode.

Returns:

a CalibrationModeMod::CalibrationMode's enumerator.

Exceptions:

a

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

static CalibrationModeMod::CalibrationMode CCalibrationMode::literal

(

const std::string &

name

)

[static]

Return a CalibrationMode's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a CalibrationModeMod::CalibrationMode's enumerator.

Exceptions:

a

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

static std::string CCalibrationMode::name

(

const CalibrationModeMod::CalibrationMode &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of CalibrationModeMod::CalibrationMode.

Returns:

a string.

static const std::vector<std::string> CCalibrationMode::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 CalibrationModeMod::CalibrationMode CCalibrationMode::newCalibrationMode

(

const std::string &

name

)

[static]

Create a CalibrationMode enumeration object by specifying its name.

CCalibrationMode& CCalibrationMode::operator=

(

const CCalibrationMode &

)

[private]

static std::string CCalibrationMode::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CCalibrationMode::size

(

)

[static]

Return the number of enumerators declared in CalibrationModeMod::CalibrationMode.

Returns:

an unsigned int.

static std::string CCalibrationMode::toString

(

const CalibrationModeMod::CalibrationMode &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 139 of file CCalibrationMode.h.

static int CCalibrationMode::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CCalibrationMode::sHOLOGRAPHY [static]

Enumerators as strings.

A const string equal to "HOLOGRAPHY".

Definition at line 96 of file CCalibrationMode.h.

const std::string& CCalibrationMode::sINTERFEROMETRY [static]

A const string equal to "INTERFEROMETRY".

Definition at line 98 of file CCalibrationMode.h.

const std::string& CCalibrationMode::sOPTICAL [static]

A const string equal to "OPTICAL".

Definition at line 100 of file CCalibrationMode.h.

const std::string& CCalibrationMode::sRADIOMETRY [static]

A const string equal to "RADIOMETRY".

Definition at line 102 of file CCalibrationMode.h.

const std::string& CCalibrationMode::sWVR [static]

A const string equal to "WVR".

Definition at line 104 of file CCalibrationMode.h.

---

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

• code/alma/Enumerations/CCalibrationMode.h