CAntennaMotionPattern Class Reference

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

#include <CAntennaMotionPattern.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 AntennaMotionPatternMod::AntennaMotionPattern.
static std::string	name (const AntennaMotionPatternMod::AntennaMotionPattern &e)
	Returns an enumerator as a string.
static std::string	toString (const AntennaMotionPatternMod::AntennaMotionPattern &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static AntennaMotionPatternMod::AntennaMotionPattern	newAntennaMotionPattern (const std::string &name)
	Create a AntennaMotionPattern enumeration object by specifying its name.
static AntennaMotionPatternMod::AntennaMotionPattern	literal (const std::string &name)
static AntennaMotionPatternMod::AntennaMotionPattern	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sNONE
	Enumerators as strings.
static const std::string &	sCROSS_SCAN
static const std::string &	sSPIRAL
static const std::string &	sCIRCLE
static const std::string &	sTHREE_POINTS
static const std::string &	sFOUR_POINTS
static const std::string &	sFIVE_POINTS
static const std::string &	sTEST
static const std::string &	sUNSPECIFIED
static const std::string &	sSTAR
static const std::string &	sLISSAJOUS
Private Member Functions
	CAntennaMotionPattern ()
	CAntennaMotionPattern (const CAntennaMotionPattern &)
CAntennaMotionPattern &	operator= (const CAntennaMotionPattern &)
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 AntennaMotionPattern.

Definition at line 101 of file CAntennaMotionPattern.h.

---

Constructor & Destructor Documentation

CAntennaMotionPattern::CAntennaMotionPattern

(

)

[private]

CAntennaMotionPattern::CAntennaMotionPattern

(

const CAntennaMotionPattern &

)

[private]

---

Member Function Documentation

static std::string CAntennaMotionPattern::badInt

(

unsigned int

i

)

[static, private]

static std::string CAntennaMotionPattern::badString

(

const std::string &

name

)

[static, private]

static AntennaMotionPatternMod::AntennaMotionPattern CAntennaMotionPattern::from_int

(

unsigned int

i

)

[static]

Return a AntennaMotionPattern's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in AntennaMotionPatternMod::AntennaMotionPattern.

Returns:

a AntennaMotionPatternMod::AntennaMotionPattern's enumerator.

Exceptions:

a

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

static AntennaMotionPatternMod::AntennaMotionPattern CAntennaMotionPattern::literal

(

const std::string &

name

)

[static]

Return a AntennaMotionPattern's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a AntennaMotionPatternMod::AntennaMotionPattern's enumerator.

Exceptions:

a

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

static std::string CAntennaMotionPattern::name

(

const AntennaMotionPatternMod::AntennaMotionPattern &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of AntennaMotionPatternMod::AntennaMotionPattern.

Returns:

a string.

static const std::vector<std::string> CAntennaMotionPattern::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 AntennaMotionPatternMod::AntennaMotionPattern CAntennaMotionPattern::newAntennaMotionPattern

(

const std::string &

name

)

[static]

Create a AntennaMotionPattern enumeration object by specifying its name.

CAntennaMotionPattern& CAntennaMotionPattern::operator=

(

const CAntennaMotionPattern &

)

[private]

static std::string CAntennaMotionPattern::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CAntennaMotionPattern::size

(

)

[static]

Return the number of enumerators declared in AntennaMotionPatternMod::AntennaMotionPattern.

Returns:

an unsigned int.

static std::string CAntennaMotionPattern::toString

(

const AntennaMotionPatternMod::AntennaMotionPattern &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 163 of file CAntennaMotionPattern.h.

static int CAntennaMotionPattern::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CAntennaMotionPattern::sCIRCLE [static]

A const string equal to "CIRCLE".

Definition at line 114 of file CAntennaMotionPattern.h.

const std::string& CAntennaMotionPattern::sCROSS_SCAN [static]

A const string equal to "CROSS_SCAN".

Definition at line 110 of file CAntennaMotionPattern.h.

const std::string& CAntennaMotionPattern::sFIVE_POINTS [static]

A const string equal to "FIVE_POINTS".

Definition at line 120 of file CAntennaMotionPattern.h.

const std::string& CAntennaMotionPattern::sFOUR_POINTS [static]

A const string equal to "FOUR_POINTS".

Definition at line 118 of file CAntennaMotionPattern.h.

const std::string& CAntennaMotionPattern::sLISSAJOUS [static]

A const string equal to "LISSAJOUS".

Definition at line 128 of file CAntennaMotionPattern.h.

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

Enumerators as strings.

A const string equal to "NONE".

Definition at line 108 of file CAntennaMotionPattern.h.

const std::string& CAntennaMotionPattern::sSPIRAL [static]

A const string equal to "SPIRAL".

Definition at line 112 of file CAntennaMotionPattern.h.

const std::string& CAntennaMotionPattern::sSTAR [static]

A const string equal to "STAR".

Definition at line 126 of file CAntennaMotionPattern.h.

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

A const string equal to "TEST".

Definition at line 122 of file CAntennaMotionPattern.h.

const std::string& CAntennaMotionPattern::sTHREE_POINTS [static]

A const string equal to "THREE_POINTS".

Definition at line 116 of file CAntennaMotionPattern.h.

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

A const string equal to "UNSPECIFIED".

Definition at line 124 of file CAntennaMotionPattern.h.

---

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

• code/alma/Enumerations/CAntennaMotionPattern.h