CCalDataOrigin Class Reference

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

#include <CCalDataOrigin.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 CalDataOriginMod::CalDataOrigin.
static std::string	name (const CalDataOriginMod::CalDataOrigin &e)
	Returns an enumerator as a string.
static std::string	toString (const CalDataOriginMod::CalDataOrigin &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static CalDataOriginMod::CalDataOrigin	newCalDataOrigin (const std::string &name)
	Create a CalDataOrigin enumeration object by specifying its name.
static CalDataOriginMod::CalDataOrigin	literal (const std::string &name)
static CalDataOriginMod::CalDataOrigin	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 CalDataOriginMod::CalDataOrigin.
static std::string	name (const CalDataOriginMod::CalDataOrigin &e)
	Returns an enumerator as a string.
static std::string	toString (const CalDataOriginMod::CalDataOrigin &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static CalDataOriginMod::CalDataOrigin	newCalDataOrigin (const std::string &name)
	Create a CalDataOrigin enumeration object by specifying its name.
static CalDataOriginMod::CalDataOrigin	literal (const std::string &name)
static CalDataOriginMod::CalDataOrigin	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sTOTAL_POWER
	Enumerators as strings.
static const std::string &	sWVR
static const std::string &	sCHANNEL_AVERAGE_AUTO
static const std::string &	sCHANNEL_AVERAGE_CROSS
static const std::string &	sFULL_RESOLUTION_AUTO
static const std::string &	sFULL_RESOLUTION_CROSS
static const std::string &	sOPTICAL_POINTING
static const std::string &	sHOLOGRAPHY
static const std::string &	sNONE
Private Member Functions
	CCalDataOrigin ()
	CCalDataOrigin (const CCalDataOrigin &)
CCalDataOrigin &	operator= (const CCalDataOrigin &)
	CCalDataOrigin ()
	CCalDataOrigin (const CCalDataOrigin &)
CCalDataOrigin &	operator= (const CCalDataOrigin &)
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 CalDataOrigin.

Definition at line 97 of file CCalDataOrigin.h.

---

Constructor & Destructor Documentation

CCalDataOrigin::CCalDataOrigin

(

)

[private]

CCalDataOrigin::CCalDataOrigin

(

const CCalDataOrigin &

)

[private]

CCalDataOrigin::CCalDataOrigin

(

)

[private]

CCalDataOrigin::CCalDataOrigin

(

const CCalDataOrigin &

)

[private]

---

Member Function Documentation

static std::string CCalDataOrigin::badInt

(

unsigned int

i

)

[static, private]

static std::string CCalDataOrigin::badInt

(

unsigned int

i

)

[static, private]

static std::string CCalDataOrigin::badString

(

const std::string &

name

)

[static, private]

static std::string CCalDataOrigin::badString

(

const std::string &

name

)

[static, private]

static CalDataOriginMod::CalDataOrigin CCalDataOrigin::from_int

(

unsigned int

i

)

[static]

Return a CalDataOrigin's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in CalDataOriginMod::CalDataOrigin.

Returns:

a CalDataOriginMod::CalDataOrigin's enumerator.

Exceptions:

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

static CalDataOriginMod::CalDataOrigin CCalDataOrigin::from_int

(

unsigned int

i

)

[static]

Return a CalDataOrigin's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in CalDataOriginMod::CalDataOrigin.

Returns:

a CalDataOriginMod::CalDataOrigin's enumerator.

Exceptions:

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

static CalDataOriginMod::CalDataOrigin CCalDataOrigin::literal

(

const std::string &

name

)

[static]

Return a CalDataOrigin's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a CalDataOriginMod::CalDataOrigin's enumerator.

Exceptions:

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

static CalDataOriginMod::CalDataOrigin CCalDataOrigin::literal

(

const std::string &

name

)

[static]

Return a CalDataOrigin's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a CalDataOriginMod::CalDataOrigin's enumerator.

Exceptions:

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

static std::string CCalDataOrigin::name

(

const CalDataOriginMod::CalDataOrigin &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of CalDataOriginMod::CalDataOrigin.

Returns:

a string.

static std::string CCalDataOrigin::name

(

const CalDataOriginMod::CalDataOrigin &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of CalDataOriginMod::CalDataOrigin.

Returns:

a string.

static const std::vector<std::string> CCalDataOrigin::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> CCalDataOrigin::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 CalDataOriginMod::CalDataOrigin CCalDataOrigin::newCalDataOrigin

(

const std::string &

name

)

[static]

Create a CalDataOrigin enumeration object by specifying its name.

static CalDataOriginMod::CalDataOrigin CCalDataOrigin::newCalDataOrigin

(

const std::string &

name

)

[static]

Create a CalDataOrigin enumeration object by specifying its name.

CCalDataOrigin& CCalDataOrigin::operator=

(

const CCalDataOrigin &

)

[private]

CCalDataOrigin& CCalDataOrigin::operator=

(

const CCalDataOrigin &

)

[private]

static std::string CCalDataOrigin::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static std::string CCalDataOrigin::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CCalDataOrigin::size

(

)

[static]

Return the number of enumerators declared in CalDataOriginMod::CalDataOrigin.

Returns:

an unsigned int.

static unsigned int CCalDataOrigin::size

(

)

[static]

Return the number of enumerators declared in CalDataOriginMod::CalDataOrigin.

Returns:

an unsigned int.

static std::string CCalDataOrigin::toString

(

const CalDataOriginMod::CalDataOrigin &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 155 of file CCalDataOrigin.h.

static std::string CCalDataOrigin::toString

(

const CalDataOriginMod::CalDataOrigin &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 155 of file CCalDataOrigin.h.

static int CCalDataOrigin::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

static int CCalDataOrigin::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

static const std::string & CCalDataOrigin::sCHANNEL_AVERAGE_AUTO [static]

A const string equal to "CHANNEL_AVERAGE_AUTO".

Definition at line 108 of file CCalDataOrigin.h.

static const std::string & CCalDataOrigin::sCHANNEL_AVERAGE_CROSS [static]

A const string equal to "CHANNEL_AVERAGE_CROSS".

Definition at line 110 of file CCalDataOrigin.h.

static const std::string & CCalDataOrigin::sFULL_RESOLUTION_AUTO [static]

A const string equal to "FULL_RESOLUTION_AUTO".

Definition at line 112 of file CCalDataOrigin.h.

static const std::string & CCalDataOrigin::sFULL_RESOLUTION_CROSS [static]

A const string equal to "FULL_RESOLUTION_CROSS".

Definition at line 114 of file CCalDataOrigin.h.

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

A const string equal to "HOLOGRAPHY".

Definition at line 118 of file CCalDataOrigin.h.

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

A const string equal to "NONE".

Definition at line 120 of file CCalDataOrigin.h.

static const std::string & CCalDataOrigin::sOPTICAL_POINTING [static]

A const string equal to "OPTICAL_POINTING".

Definition at line 116 of file CCalDataOrigin.h.

static const std::string & CCalDataOrigin::sTOTAL_POWER [static]

Enumerators as strings.

A const string equal to "TOTAL_POWER".

Definition at line 104 of file CCalDataOrigin.h.

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

A const string equal to "WVR".

Definition at line 106 of file CCalDataOrigin.h.

---

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

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