CCalibrationDevice Class Reference

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

#include <CCalibrationDevice.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 CalibrationDeviceMod::CalibrationDevice.
static std::string	name (const CalibrationDeviceMod::CalibrationDevice &e)
	Returns an enumerator as a string.
static std::string	toString (const CalibrationDeviceMod::CalibrationDevice &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static CalibrationDeviceMod::CalibrationDevice	newCalibrationDevice (const std::string &name)
	Create a CalibrationDevice enumeration object by specifying its name.
static CalibrationDeviceMod::CalibrationDevice	literal (const std::string &name)
static CalibrationDeviceMod::CalibrationDevice	from_int (unsigned int i)
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 CalibrationDeviceMod::CalibrationDevice.
static std::string	name (const CalibrationDeviceMod::CalibrationDevice &e)
	Returns an enumerator as a string.
static std::string	toString (const CalibrationDeviceMod::CalibrationDevice &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static CalibrationDeviceMod::CalibrationDevice	newCalibrationDevice (const std::string &name)
	Create a CalibrationDevice enumeration object by specifying its name.
static CalibrationDeviceMod::CalibrationDevice	literal (const std::string &name)
static CalibrationDeviceMod::CalibrationDevice	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sAMBIENT_LOAD
	Enumerators as strings.
static const std::string &	sCOLD_LOAD
static const std::string &	sHOT_LOAD
static const std::string &	sNOISE_TUBE_LOAD
static const std::string &	sQUARTER_WAVE_PLATE
static const std::string &	sSOLAR_FILTER
static const std::string &	sNONE
Private Member Functions
	CCalibrationDevice ()
	CCalibrationDevice (const CCalibrationDevice &)
CCalibrationDevice &	operator= (const CCalibrationDevice &)
	CCalibrationDevice ()
	CCalibrationDevice (const CCalibrationDevice &)
CCalibrationDevice &	operator= (const CCalibrationDevice &)
Static Private Member Functions
static std::string	badString (const std::string &name)
static std::string	badInt (unsigned int i)
static std::string	badString (const std::string &name)
static std::string	badInt (unsigned int i)

---

Detailed Description

A helper class for the enumeration CalibrationDevice.

Definition at line 93 of file CCalibrationDevice.h.

---

Constructor & Destructor Documentation

CCalibrationDevice::CCalibrationDevice

(

)

[private]

CCalibrationDevice::CCalibrationDevice

(

const CCalibrationDevice &

)

[private]

CCalibrationDevice::CCalibrationDevice

(

)

[private]

CCalibrationDevice::CCalibrationDevice

(

const CCalibrationDevice &

)

[private]

---

Member Function Documentation

static std::string CCalibrationDevice::badInt

(

unsigned int

i

)

[static, private]

static std::string CCalibrationDevice::badInt

(

unsigned int

i

)

[static, private]

static std::string CCalibrationDevice::badString

(

const std::string &

name

)

[static, private]

static std::string CCalibrationDevice::badString

(

const std::string &

name

)

[static, private]

static CalibrationDeviceMod::CalibrationDevice CCalibrationDevice::from_int

(

unsigned int

i

)

[static]

Return a CalibrationDevice's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in CalibrationDeviceMod::CalibrationDevice.

Returns:

a CalibrationDeviceMod::CalibrationDevice's enumerator.

Exceptions:

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

static CalibrationDeviceMod::CalibrationDevice CCalibrationDevice::from_int

(

unsigned int

i

)

[static]

Return a CalibrationDevice's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in CalibrationDeviceMod::CalibrationDevice.

Returns:

a CalibrationDeviceMod::CalibrationDevice's enumerator.

Exceptions:

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

static CalibrationDeviceMod::CalibrationDevice CCalibrationDevice::literal

(

const std::string &

name

)

[static]

Return a CalibrationDevice's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a CalibrationDeviceMod::CalibrationDevice's enumerator.

Exceptions:

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

static CalibrationDeviceMod::CalibrationDevice CCalibrationDevice::literal

(

const std::string &

name

)

[static]

Return a CalibrationDevice's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a CalibrationDeviceMod::CalibrationDevice's enumerator.

Exceptions:

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

static std::string CCalibrationDevice::name

(

const CalibrationDeviceMod::CalibrationDevice &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of CalibrationDeviceMod::CalibrationDevice.

Returns:

a string.

static std::string CCalibrationDevice::name

(

const CalibrationDeviceMod::CalibrationDevice &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of CalibrationDeviceMod::CalibrationDevice.

Returns:

a string.

static const std::vector<std::string> CCalibrationDevice::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 const std::vector<std::string> CCalibrationDevice::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 CalibrationDeviceMod::CalibrationDevice CCalibrationDevice::newCalibrationDevice

(

const std::string &

name

)

[static]

Create a CalibrationDevice enumeration object by specifying its name.

static CalibrationDeviceMod::CalibrationDevice CCalibrationDevice::newCalibrationDevice

(

const std::string &

name

)

[static]

Create a CalibrationDevice enumeration object by specifying its name.

CCalibrationDevice& CCalibrationDevice::operator=

(

const CCalibrationDevice &

)

[private]

CCalibrationDevice& CCalibrationDevice::operator=

(

const CCalibrationDevice &

)

[private]

static std::string CCalibrationDevice::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static std::string CCalibrationDevice::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CCalibrationDevice::size

(

)

[static]

Return the number of enumerators declared in CalibrationDeviceMod::CalibrationDevice.

Returns:

an unsigned int.

static unsigned int CCalibrationDevice::size

(

)

[static]

Return the number of enumerators declared in CalibrationDeviceMod::CalibrationDevice.

Returns:

an unsigned int.

static std::string CCalibrationDevice::toString

(

const CalibrationDeviceMod::CalibrationDevice &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 147 of file CCalibrationDevice.h.

static std::string CCalibrationDevice::toString

(

const CalibrationDeviceMod::CalibrationDevice &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 147 of file CCalibrationDevice.h.

static int CCalibrationDevice::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

static int CCalibrationDevice::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

static const std::string & CCalibrationDevice::sAMBIENT_LOAD [static]

Enumerators as strings.

A const string equal to "AMBIENT_LOAD".

Definition at line 100 of file CCalibrationDevice.h.

static const std::string & CCalibrationDevice::sCOLD_LOAD [static]

A const string equal to "COLD_LOAD".

Definition at line 102 of file CCalibrationDevice.h.

static const std::string & CCalibrationDevice::sHOT_LOAD [static]

A const string equal to "HOT_LOAD".

Definition at line 104 of file CCalibrationDevice.h.

static const std::string & CCalibrationDevice::sNOISE_TUBE_LOAD [static]

A const string equal to "NOISE_TUBE_LOAD".

Definition at line 106 of file CCalibrationDevice.h.

static const std::string & CCalibrationDevice::sNONE [static]

A const string equal to "NONE".

Definition at line 112 of file CCalibrationDevice.h.

static const std::string & CCalibrationDevice::sQUARTER_WAVE_PLATE [static]

A const string equal to "QUARTER_WAVE_PLATE".

Definition at line 108 of file CCalibrationDevice.h.

static const std::string & CCalibrationDevice::sSOLAR_FILTER [static]

A const string equal to "SOLAR_FILTER".

Definition at line 110 of file CCalibrationDevice.h.

---

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

• code/alma/Enumerations/CCalibrationDevice.h
• code/alma_v3/Enumerations/CCalibrationDevice.h