CAssociatedCalNature Class Reference

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

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

Definition at line 81 of file CAssociatedCalNature.h.

---

Constructor & Destructor Documentation

CAssociatedCalNature::CAssociatedCalNature

(

)

[private]

CAssociatedCalNature::CAssociatedCalNature

(

const CAssociatedCalNature &

)

[private]

---

Member Function Documentation

static std::string CAssociatedCalNature::badInt

(

unsigned int

i

)

[static, private]

static std::string CAssociatedCalNature::badString

(

const std::string &

name

)

[static, private]

static AssociatedCalNatureMod::AssociatedCalNature CAssociatedCalNature::from_int

(

unsigned int

i

)

[static]

Return a AssociatedCalNature's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in AssociatedCalNatureMod::AssociatedCalNature.

Returns:

a AssociatedCalNatureMod::AssociatedCalNature's enumerator.

Exceptions:

a

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

static AssociatedCalNatureMod::AssociatedCalNature CAssociatedCalNature::literal

(

const std::string &

name

)

[static]

Return a AssociatedCalNature's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a AssociatedCalNatureMod::AssociatedCalNature's enumerator.

Exceptions:

a

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

static std::string CAssociatedCalNature::name

(

const AssociatedCalNatureMod::AssociatedCalNature &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of AssociatedCalNatureMod::AssociatedCalNature.

Returns:

a string.

static const std::vector<std::string> CAssociatedCalNature::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 AssociatedCalNatureMod::AssociatedCalNature CAssociatedCalNature::newAssociatedCalNature

(

const std::string &

name

)

[static]

Create a AssociatedCalNature enumeration object by specifying its name.

CAssociatedCalNature& CAssociatedCalNature::operator=

(

const CAssociatedCalNature &

)

[private]

static std::string CAssociatedCalNature::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CAssociatedCalNature::size

(

)

[static]

Return the number of enumerators declared in AssociatedCalNatureMod::AssociatedCalNature.

Returns:

an unsigned int.

static std::string CAssociatedCalNature::toString

(

const AssociatedCalNatureMod::AssociatedCalNature &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 123 of file CAssociatedCalNature.h.

static int CAssociatedCalNature::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CAssociatedCalNature::sASSOCIATED_EXECBLOCK [static]

Enumerators as strings.

A const string equal to "ASSOCIATED_EXECBLOCK".

Definition at line 88 of file CAssociatedCalNature.h.

---

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

• code/alma/Enumerations/CAssociatedCalNature.h