CSwitchingMode Class Reference

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

#include <CSwitchingMode.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 SwitchingModeMod::SwitchingMode.
static std::string	name (const SwitchingModeMod::SwitchingMode &e)
	Returns an enumerator as a string.
static std::string	toString (const SwitchingModeMod::SwitchingMode &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static SwitchingModeMod::SwitchingMode	newSwitchingMode (const std::string &name)
	Create a SwitchingMode enumeration object by specifying its name.
static SwitchingModeMod::SwitchingMode	literal (const std::string &name)
static SwitchingModeMod::SwitchingMode	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sNO_SWITCHING
	Enumerators as strings.
static const std::string &	sLOAD_SWITCHING
static const std::string &	sPOSITION_SWITCHING
static const std::string &	sPHASE_SWITCHING
static const std::string &	sFREQUENCY_SWITCHING
static const std::string &	sNUTATOR_SWITCHING
static const std::string &	sCHOPPER_WHEEL
Private Member Functions
	CSwitchingMode ()
	CSwitchingMode (const CSwitchingMode &)
CSwitchingMode &	operator= (const CSwitchingMode &)
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 SwitchingMode.

Definition at line 93 of file CSwitchingMode.h.

---

Constructor & Destructor Documentation

CSwitchingMode::CSwitchingMode

(

)

[private]

CSwitchingMode::CSwitchingMode

(

const CSwitchingMode &

)

[private]

---

Member Function Documentation

static std::string CSwitchingMode::badInt

(

unsigned int

i

)

[static, private]

static std::string CSwitchingMode::badString

(

const std::string &

name

)

[static, private]

static SwitchingModeMod::SwitchingMode CSwitchingMode::from_int

(

unsigned int

i

)

[static]

Return a SwitchingMode's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in SwitchingModeMod::SwitchingMode.

Returns:

a SwitchingModeMod::SwitchingMode's enumerator.

Exceptions:

a

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

static SwitchingModeMod::SwitchingMode CSwitchingMode::literal

(

const std::string &

name

)

[static]

Return a SwitchingMode's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a SwitchingModeMod::SwitchingMode's enumerator.

Exceptions:

a

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

static std::string CSwitchingMode::name

(

const SwitchingModeMod::SwitchingMode &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of SwitchingModeMod::SwitchingMode.

Returns:

a string.

static const std::vector<std::string> CSwitchingMode::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 SwitchingModeMod::SwitchingMode CSwitchingMode::newSwitchingMode

(

const std::string &

name

)

[static]

Create a SwitchingMode enumeration object by specifying its name.

CSwitchingMode& CSwitchingMode::operator=

(

const CSwitchingMode &

)

[private]

static std::string CSwitchingMode::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CSwitchingMode::size

(

)

[static]

Return the number of enumerators declared in SwitchingModeMod::SwitchingMode.

Returns:

an unsigned int.

static std::string CSwitchingMode::toString

(

const SwitchingModeMod::SwitchingMode &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 147 of file CSwitchingMode.h.

static int CSwitchingMode::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CSwitchingMode::sCHOPPER_WHEEL [static]

A const string equal to "CHOPPER_WHEEL".

Definition at line 112 of file CSwitchingMode.h.

const std::string& CSwitchingMode::sFREQUENCY_SWITCHING [static]

A const string equal to "FREQUENCY_SWITCHING".

Definition at line 108 of file CSwitchingMode.h.

const std::string& CSwitchingMode::sLOAD_SWITCHING [static]

A const string equal to "LOAD_SWITCHING".

Definition at line 102 of file CSwitchingMode.h.

const std::string& CSwitchingMode::sNO_SWITCHING [static]

Enumerators as strings.

A const string equal to "NO_SWITCHING".

Definition at line 100 of file CSwitchingMode.h.

const std::string& CSwitchingMode::sNUTATOR_SWITCHING [static]

A const string equal to "NUTATOR_SWITCHING".

Definition at line 110 of file CSwitchingMode.h.

const std::string& CSwitchingMode::sPHASE_SWITCHING [static]

A const string equal to "PHASE_SWITCHING".

Definition at line 106 of file CSwitchingMode.h.

const std::string& CSwitchingMode::sPOSITION_SWITCHING [static]

A const string equal to "POSITION_SWITCHING".

Definition at line 104 of file CSwitchingMode.h.

---

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

• code/alma/Enumerations/CSwitchingMode.h