CDifferenceType Class Reference

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

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

Definition at line 87 of file CDifferenceType.h.

---

Constructor & Destructor Documentation

CDifferenceType::CDifferenceType

(

)

[private]

CDifferenceType::CDifferenceType

(

const CDifferenceType &

)

[private]

---

Member Function Documentation

static std::string CDifferenceType::badInt

(

unsigned int

i

)

[static, private]

static std::string CDifferenceType::badString

(

const std::string &

name

)

[static, private]

static DifferenceTypeMod::DifferenceType CDifferenceType::from_int

(

unsigned int

i

)

[static]

Return a DifferenceType's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in DifferenceTypeMod::DifferenceType.

Returns:

a DifferenceTypeMod::DifferenceType's enumerator.

Exceptions:

a

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

static DifferenceTypeMod::DifferenceType CDifferenceType::literal

(

const std::string &

name

)

[static]

Return a DifferenceType's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a DifferenceTypeMod::DifferenceType's enumerator.

Exceptions:

a

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

static std::string CDifferenceType::name

(

const DifferenceTypeMod::DifferenceType &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of DifferenceTypeMod::DifferenceType.

Returns:

a string.

static const std::vector<std::string> CDifferenceType::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 DifferenceTypeMod::DifferenceType CDifferenceType::newDifferenceType

(

const std::string &

name

)

[static]

Create a DifferenceType enumeration object by specifying its name.

CDifferenceType& CDifferenceType::operator=

(

const CDifferenceType &

)

[private]

static std::string CDifferenceType::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CDifferenceType::size

(

)

[static]

Return the number of enumerators declared in DifferenceTypeMod::DifferenceType.

Returns:

an unsigned int.

static std::string CDifferenceType::toString

(

const DifferenceTypeMod::DifferenceType &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 135 of file CDifferenceType.h.

static int CDifferenceType::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CDifferenceType::sFINAL [static]

A const string equal to "FINAL".

Definition at line 100 of file CDifferenceType.h.

const std::string& CDifferenceType::sPREDICTED [static]

Enumerators as strings.

A const string equal to "PREDICTED".

Definition at line 94 of file CDifferenceType.h.

const std::string& CDifferenceType::sPRELIMINARY [static]

A const string equal to "PRELIMINARY".

Definition at line 96 of file CDifferenceType.h.

const std::string& CDifferenceType::sRAPID [static]

A const string equal to "RAPID".

Definition at line 98 of file CDifferenceType.h.

---

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

• code/alma/Enumerations/CDifferenceType.h