CScanIntent Class Reference

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

#include <CScanIntent.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 ScanIntentMod::ScanIntent.
static std::string	name (const ScanIntentMod::ScanIntent &e)
	Returns an enumerator as a string.
static std::string	toString (const ScanIntentMod::ScanIntent &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static ScanIntentMod::ScanIntent	newScanIntent (const std::string &name)
	Create a ScanIntent enumeration object by specifying its name.
static ScanIntentMod::ScanIntent	literal (const std::string &name)
static ScanIntentMod::ScanIntent	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 ScanIntentMod::ScanIntent.
static std::string	name (const ScanIntentMod::ScanIntent &e)
	Returns an enumerator as a string.
static std::string	toString (const ScanIntentMod::ScanIntent &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static ScanIntentMod::ScanIntent	newScanIntent (const std::string &name)
	Create a ScanIntent enumeration object by specifying its name.
static ScanIntentMod::ScanIntent	literal (const std::string &name)
static ScanIntentMod::ScanIntent	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sCALIBRATE_AMPLI
	Enumerators as strings.
static const std::string &	sCALIBRATE_ATMOSPHERE
static const std::string &	sCALIBRATE_BANDPASS
static const std::string &	sCALIBRATE_DELAY
static const std::string &	sCALIBRATE_FLUX
static const std::string &	sCALIBRATE_FOCUS
static const std::string &	sCALIBRATE_FOCUS_X
static const std::string &	sCALIBRATE_FOCUS_Y
static const std::string &	sCALIBRATE_PHASE
static const std::string &	sCALIBRATE_POINTING
static const std::string &	sCALIBRATE_POLARIZATION
static const std::string &	sCALIBRATE_SIDEBAND_RATIO
static const std::string &	sCALIBRATE_WVR
static const std::string &	sDO_SKYDIP
static const std::string &	sMAP_ANTENNA_SURFACE
static const std::string &	sMAP_PRIMARY_BEAM
static const std::string &	sOBSERVE_TARGET
static const std::string &	sCALIBRATE_POL_LEAKAGE
static const std::string &	sCALIBRATE_POL_ANGLE
static const std::string &	sTEST
static const std::string &	sUNSPECIFIED
Private Member Functions
	CScanIntent ()
	CScanIntent (const CScanIntent &)
CScanIntent &	operator= (const CScanIntent &)
	CScanIntent ()
	CScanIntent (const CScanIntent &)
CScanIntent &	operator= (const CScanIntent &)
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 ScanIntent.

Definition at line 121 of file CScanIntent.h.

---

Constructor & Destructor Documentation

CScanIntent::CScanIntent

(

)

[private]

CScanIntent::CScanIntent

(

const CScanIntent &

)

[private]

CScanIntent::CScanIntent

(

)

[private]

CScanIntent::CScanIntent

(

const CScanIntent &

)

[private]

---

Member Function Documentation

static std::string CScanIntent::badInt

(

unsigned int

i

)

[static, private]

static std::string CScanIntent::badInt

(

unsigned int

i

)

[static, private]

static std::string CScanIntent::badString

(

const std::string &

name

)

[static, private]

static std::string CScanIntent::badString

(

const std::string &

name

)

[static, private]

static ScanIntentMod::ScanIntent CScanIntent::from_int

(

unsigned int

i

)

[static]

Return a ScanIntent's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in ScanIntentMod::ScanIntent.

Returns:

a ScanIntentMod::ScanIntent's enumerator.

Exceptions:

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

static ScanIntentMod::ScanIntent CScanIntent::from_int

(

unsigned int

i

)

[static]

Return a ScanIntent's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in ScanIntentMod::ScanIntent.

Returns:

a ScanIntentMod::ScanIntent's enumerator.

Exceptions:

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

static ScanIntentMod::ScanIntent CScanIntent::literal

(

const std::string &

name

)

[static]

Return a ScanIntent's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a ScanIntentMod::ScanIntent's enumerator.

Exceptions:

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

static ScanIntentMod::ScanIntent CScanIntent::literal

(

const std::string &

name

)

[static]

Return a ScanIntent's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a ScanIntentMod::ScanIntent's enumerator.

Exceptions:

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

static std::string CScanIntent::name

(

const ScanIntentMod::ScanIntent &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of ScanIntentMod::ScanIntent.

Returns:

a string.

static std::string CScanIntent::name

(

const ScanIntentMod::ScanIntent &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of ScanIntentMod::ScanIntent.

Returns:

a string.

static const std::vector<std::string> CScanIntent::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> CScanIntent::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 ScanIntentMod::ScanIntent CScanIntent::newScanIntent

(

const std::string &

name

)

[static]

Create a ScanIntent enumeration object by specifying its name.

static ScanIntentMod::ScanIntent CScanIntent::newScanIntent

(

const std::string &

name

)

[static]

Create a ScanIntent enumeration object by specifying its name.

CScanIntent& CScanIntent::operator=

(

const CScanIntent &

)

[private]

CScanIntent& CScanIntent::operator=

(

const CScanIntent &

)

[private]

static std::string CScanIntent::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static std::string CScanIntent::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CScanIntent::size

(

)

[static]

Return the number of enumerators declared in ScanIntentMod::ScanIntent.

Returns:

an unsigned int.

static unsigned int CScanIntent::size

(

)

[static]

Return the number of enumerators declared in ScanIntentMod::ScanIntent.

Returns:

an unsigned int.

static std::string CScanIntent::toString

(

const ScanIntentMod::ScanIntent &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 203 of file CScanIntent.h.

static std::string CScanIntent::toString

(

const ScanIntentMod::ScanIntent &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 203 of file CScanIntent.h.

static int CScanIntent::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

static int CScanIntent::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

static const std::string & CScanIntent::sCALIBRATE_AMPLI [static]

Enumerators as strings.

A const string equal to "CALIBRATE_AMPLI".

Definition at line 128 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_ATMOSPHERE [static]

A const string equal to "CALIBRATE_ATMOSPHERE".

Definition at line 130 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_BANDPASS [static]

A const string equal to "CALIBRATE_BANDPASS".

Definition at line 132 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_DELAY [static]

A const string equal to "CALIBRATE_DELAY".

Definition at line 134 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_FLUX [static]

A const string equal to "CALIBRATE_FLUX".

Definition at line 136 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_FOCUS [static]

A const string equal to "CALIBRATE_FOCUS".

Definition at line 138 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_FOCUS_X [static]

A const string equal to "CALIBRATE_FOCUS_X".

Definition at line 140 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_FOCUS_Y [static]

A const string equal to "CALIBRATE_FOCUS_Y".

Definition at line 142 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_PHASE [static]

A const string equal to "CALIBRATE_PHASE".

Definition at line 144 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_POINTING [static]

A const string equal to "CALIBRATE_POINTING".

Definition at line 146 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_POL_ANGLE [static]

A const string equal to "CALIBRATE_POL_ANGLE".

Definition at line 164 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_POL_LEAKAGE [static]

A const string equal to "CALIBRATE_POL_LEAKAGE".

Definition at line 162 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_POLARIZATION [static]

A const string equal to "CALIBRATE_POLARIZATION".

Definition at line 148 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_SIDEBAND_RATIO [static]

A const string equal to "CALIBRATE_SIDEBAND_RATIO".

Definition at line 150 of file CScanIntent.h.

static const std::string & CScanIntent::sCALIBRATE_WVR [static]

A const string equal to "CALIBRATE_WVR".

Definition at line 152 of file CScanIntent.h.

static const std::string & CScanIntent::sDO_SKYDIP [static]

A const string equal to "DO_SKYDIP".

Definition at line 154 of file CScanIntent.h.

static const std::string & CScanIntent::sMAP_ANTENNA_SURFACE [static]

A const string equal to "MAP_ANTENNA_SURFACE".

Definition at line 156 of file CScanIntent.h.

static const std::string & CScanIntent::sMAP_PRIMARY_BEAM [static]

A const string equal to "MAP_PRIMARY_BEAM".

Definition at line 158 of file CScanIntent.h.

static const std::string & CScanIntent::sOBSERVE_TARGET [static]

A const string equal to "OBSERVE_TARGET".

Definition at line 160 of file CScanIntent.h.

static const std::string & CScanIntent::sTEST [static]

A const string equal to "TEST".

Definition at line 166 of file CScanIntent.h.

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

A const string equal to "UNSPECIFIED".

Definition at line 168 of file CScanIntent.h.

---

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

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