CSchedulerMode Class Reference

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

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

Definition at line 87 of file CSchedulerMode.h.

---

Constructor & Destructor Documentation

CSchedulerMode::CSchedulerMode

(

)

[private]

CSchedulerMode::CSchedulerMode

(

const CSchedulerMode &

)

[private]

---

Member Function Documentation

static std::string CSchedulerMode::badInt

(

unsigned int

i

)

[static, private]

static std::string CSchedulerMode::badString

(

const std::string &

name

)

[static, private]

static SchedulerModeMod::SchedulerMode CSchedulerMode::from_int

(

unsigned int

i

)

[static]

Return a SchedulerMode's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in SchedulerModeMod::SchedulerMode.

Returns:

a SchedulerModeMod::SchedulerMode's enumerator.

Exceptions:

a

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

static SchedulerModeMod::SchedulerMode CSchedulerMode::literal

(

const std::string &

name

)

[static]

Return a SchedulerMode's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a SchedulerModeMod::SchedulerMode's enumerator.

Exceptions:

a

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

static std::string CSchedulerMode::name

(

const SchedulerModeMod::SchedulerMode &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of SchedulerModeMod::SchedulerMode.

Returns:

a string.

static const std::vector<std::string> CSchedulerMode::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 SchedulerModeMod::SchedulerMode CSchedulerMode::newSchedulerMode

(

const std::string &

name

)

[static]

Create a SchedulerMode enumeration object by specifying its name.

CSchedulerMode& CSchedulerMode::operator=

(

const CSchedulerMode &

)

[private]

static std::string CSchedulerMode::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CSchedulerMode::size

(

)

[static]

Return the number of enumerators declared in SchedulerModeMod::SchedulerMode.

Returns:

an unsigned int.

static std::string CSchedulerMode::toString

(

const SchedulerModeMod::SchedulerMode &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 135 of file CSchedulerMode.h.

static int CSchedulerMode::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CSchedulerMode::sDYNAMIC [static]

Enumerators as strings.

A const string equal to "DYNAMIC".

Definition at line 94 of file CSchedulerMode.h.

const std::string& CSchedulerMode::sINTERACTIVE [static]

A const string equal to "INTERACTIVE".

Definition at line 96 of file CSchedulerMode.h.

const std::string& CSchedulerMode::sMANUAL [static]

A const string equal to "MANUAL".

Definition at line 98 of file CSchedulerMode.h.

const std::string& CSchedulerMode::sQUEUED [static]

A const string equal to "QUEUED".

Definition at line 100 of file CSchedulerMode.h.

---

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

• code/alma/Enumerations/CSchedulerMode.h