CPrimaryBeamDescription Class Reference

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

#include <CPrimaryBeamDescription.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 PrimaryBeamDescriptionMod::PrimaryBeamDescription.
static std::string	name (const PrimaryBeamDescriptionMod::PrimaryBeamDescription &e)
	Returns an enumerator as a string.
static std::string	toString (const PrimaryBeamDescriptionMod::PrimaryBeamDescription &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static PrimaryBeamDescriptionMod::PrimaryBeamDescription	newPrimaryBeamDescription (const std::string &name)
	Create a PrimaryBeamDescription enumeration object by specifying its name.
static PrimaryBeamDescriptionMod::PrimaryBeamDescription	literal (const std::string &name)
static PrimaryBeamDescriptionMod::PrimaryBeamDescription	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sCOMPLEX_FIELD_PATTERN
	Enumerators as strings.
static const std::string &	sAPERTURE_FIELD_DISTRIBUTION
Private Member Functions
	CPrimaryBeamDescription ()
	CPrimaryBeamDescription (const CPrimaryBeamDescription &)
CPrimaryBeamDescription &	operator= (const CPrimaryBeamDescription &)
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 PrimaryBeamDescription.

Definition at line 83 of file CPrimaryBeamDescription.h.

---

Constructor & Destructor Documentation

CPrimaryBeamDescription::CPrimaryBeamDescription

(

)

[private]

CPrimaryBeamDescription::CPrimaryBeamDescription

(

const CPrimaryBeamDescription &

)

[private]

---

Member Function Documentation

static std::string CPrimaryBeamDescription::badInt

(

unsigned int

i

)

[static, private]

static std::string CPrimaryBeamDescription::badString

(

const std::string &

name

)

[static, private]

static PrimaryBeamDescriptionMod::PrimaryBeamDescription CPrimaryBeamDescription::from_int

(

unsigned int

i

)

[static]

Return a PrimaryBeamDescription's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in PrimaryBeamDescriptionMod::PrimaryBeamDescription.

Returns:

a PrimaryBeamDescriptionMod::PrimaryBeamDescription's enumerator.

Exceptions:

a

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

static PrimaryBeamDescriptionMod::PrimaryBeamDescription CPrimaryBeamDescription::literal

(

const std::string &

name

)

[static]

Return a PrimaryBeamDescription's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a PrimaryBeamDescriptionMod::PrimaryBeamDescription's enumerator.

Exceptions:

a

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

static std::string CPrimaryBeamDescription::name

(

const PrimaryBeamDescriptionMod::PrimaryBeamDescription &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of PrimaryBeamDescriptionMod::PrimaryBeamDescription.

Returns:

a string.

static const std::vector<std::string> CPrimaryBeamDescription::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 PrimaryBeamDescriptionMod::PrimaryBeamDescription CPrimaryBeamDescription::newPrimaryBeamDescription

(

const std::string &

name

)

[static]

Create a PrimaryBeamDescription enumeration object by specifying its name.

CPrimaryBeamDescription& CPrimaryBeamDescription::operator=

(

const CPrimaryBeamDescription &

)

[private]

static std::string CPrimaryBeamDescription::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CPrimaryBeamDescription::size

(

)

[static]

Return the number of enumerators declared in PrimaryBeamDescriptionMod::PrimaryBeamDescription.

Returns:

an unsigned int.

static std::string CPrimaryBeamDescription::toString

(

const PrimaryBeamDescriptionMod::PrimaryBeamDescription &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 127 of file CPrimaryBeamDescription.h.

static int CPrimaryBeamDescription::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CPrimaryBeamDescription::sAPERTURE_FIELD_DISTRIBUTION [static]

A const string equal to "APERTURE_FIELD_DISTRIBUTION".

Definition at line 92 of file CPrimaryBeamDescription.h.

const std::string& CPrimaryBeamDescription::sCOMPLEX_FIELD_PATTERN [static]

Enumerators as strings.

A const string equal to "COMPLEX_FIELD_PATTERN".

Definition at line 90 of file CPrimaryBeamDescription.h.

---

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

• code/alma/Enumerations/CPrimaryBeamDescription.h