CFieldCode Class Reference

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

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

---

Detailed Description

A helper class for the enumeration FieldCode.

Definition at line 81 of file CFieldCode.h.

---

Constructor & Destructor Documentation

CFieldCode::CFieldCode

(

)

[private]

CFieldCode::CFieldCode

(

const CFieldCode &

)

[private]

CFieldCode::CFieldCode

(

)

[private]

CFieldCode::CFieldCode

(

const CFieldCode &

)

[private]

---

Member Function Documentation

static std::string CFieldCode::badInt

(

unsigned int

i

)

[static, private]

static std::string CFieldCode::badInt

(

unsigned int

i

)

[static, private]

static std::string CFieldCode::badString

(

const std::string &

name

)

[static, private]

static std::string CFieldCode::badString

(

const std::string &

name

)

[static, private]

static FieldCodeMod::FieldCode CFieldCode::from_int

(

unsigned int

i

)

[static]

Return a FieldCode's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in FieldCodeMod::FieldCode.

Returns:

a FieldCodeMod::FieldCode's enumerator.

Exceptions:

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

static FieldCodeMod::FieldCode CFieldCode::from_int

(

unsigned int

i

)

[static]

Return a FieldCode's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in FieldCodeMod::FieldCode.

Returns:

a FieldCodeMod::FieldCode's enumerator.

Exceptions:

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

static FieldCodeMod::FieldCode CFieldCode::literal

(

const std::string &

name

)

[static]

Return a FieldCode's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a FieldCodeMod::FieldCode's enumerator.

Exceptions:

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

static FieldCodeMod::FieldCode CFieldCode::literal

(

const std::string &

name

)

[static]

Return a FieldCode's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a FieldCodeMod::FieldCode's enumerator.

Exceptions:

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

static std::string CFieldCode::name

(

const FieldCodeMod::FieldCode &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of FieldCodeMod::FieldCode.

Returns:

a string.

static std::string CFieldCode::name

(

const FieldCodeMod::FieldCode &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of FieldCodeMod::FieldCode.

Returns:

a string.

static const std::vector<std::string> CFieldCode::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 const std::vector<std::string> CFieldCode::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 FieldCodeMod::FieldCode CFieldCode::newFieldCode

(

const std::string &

name

)

[static]

Create a FieldCode enumeration object by specifying its name.

static FieldCodeMod::FieldCode CFieldCode::newFieldCode

(

const std::string &

name

)

[static]

Create a FieldCode enumeration object by specifying its name.

CFieldCode& CFieldCode::operator=

(

const CFieldCode &

)

[private]

CFieldCode& CFieldCode::operator=

(

const CFieldCode &

)

[private]

static std::string CFieldCode::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static std::string CFieldCode::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CFieldCode::size

(

)

[static]

Return the number of enumerators declared in FieldCodeMod::FieldCode.

Returns:

an unsigned int.

static unsigned int CFieldCode::size

(

)

[static]

Return the number of enumerators declared in FieldCodeMod::FieldCode.

Returns:

an unsigned int.

static std::string CFieldCode::toString

(

const FieldCodeMod::FieldCode &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 123 of file CFieldCode.h.

static std::string CFieldCode::toString

(

const FieldCodeMod::FieldCode &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 123 of file CFieldCode.h.

static int CFieldCode::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

static int CFieldCode::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

static const std::string & CFieldCode::sNONE [static]

Enumerators as strings.

A const string equal to "NONE".

Definition at line 88 of file CFieldCode.h.

---

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

• code/alma/Enumerations/CFieldCode.h
• code/alma_v3/Enumerations/CFieldCode.h