CCorrelatorType Class Reference

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

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

Definition at line 85 of file CCorrelatorType.h.

---

Constructor & Destructor Documentation

CCorrelatorType::CCorrelatorType

(

)

[private]

CCorrelatorType::CCorrelatorType

(

const CCorrelatorType &

)

[private]

CCorrelatorType::CCorrelatorType

(

)

[private]

CCorrelatorType::CCorrelatorType

(

const CCorrelatorType &

)

[private]

---

Member Function Documentation

static std::string CCorrelatorType::badInt

(

unsigned int

i

)

[static, private]

static std::string CCorrelatorType::badInt

(

unsigned int

i

)

[static, private]

static std::string CCorrelatorType::badString

(

const std::string &

name

)

[static, private]

static std::string CCorrelatorType::badString

(

const std::string &

name

)

[static, private]

static CorrelatorTypeMod::CorrelatorType CCorrelatorType::from_int

(

unsigned int

i

)

[static]

Return a CorrelatorType's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in CorrelatorTypeMod::CorrelatorType.

Returns:

a CorrelatorTypeMod::CorrelatorType's enumerator.

Exceptions:

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

static CorrelatorTypeMod::CorrelatorType CCorrelatorType::from_int

(

unsigned int

i

)

[static]

Return a CorrelatorType's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in CorrelatorTypeMod::CorrelatorType.

Returns:

a CorrelatorTypeMod::CorrelatorType's enumerator.

Exceptions:

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

static CorrelatorTypeMod::CorrelatorType CCorrelatorType::literal

(

const std::string &

name

)

[static]

Return a CorrelatorType's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a CorrelatorTypeMod::CorrelatorType's enumerator.

Exceptions:

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

static CorrelatorTypeMod::CorrelatorType CCorrelatorType::literal

(

const std::string &

name

)

[static]

Return a CorrelatorType's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a CorrelatorTypeMod::CorrelatorType's enumerator.

Exceptions:

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

static std::string CCorrelatorType::name

(

const CorrelatorTypeMod::CorrelatorType &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of CorrelatorTypeMod::CorrelatorType.

Returns:

a string.

static std::string CCorrelatorType::name

(

const CorrelatorTypeMod::CorrelatorType &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of CorrelatorTypeMod::CorrelatorType.

Returns:

a string.

static const std::vector<std::string> CCorrelatorType::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> CCorrelatorType::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 CorrelatorTypeMod::CorrelatorType CCorrelatorType::newCorrelatorType

(

const std::string &

name

)

[static]

Create a CorrelatorType enumeration object by specifying its name.

static CorrelatorTypeMod::CorrelatorType CCorrelatorType::newCorrelatorType

(

const std::string &

name

)

[static]

Create a CorrelatorType enumeration object by specifying its name.

CCorrelatorType& CCorrelatorType::operator=

(

const CCorrelatorType &

)

[private]

CCorrelatorType& CCorrelatorType::operator=

(

const CCorrelatorType &

)

[private]

static std::string CCorrelatorType::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static std::string CCorrelatorType::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CCorrelatorType::size

(

)

[static]

Return the number of enumerators declared in CorrelatorTypeMod::CorrelatorType.

Returns:

an unsigned int.

static unsigned int CCorrelatorType::size

(

)

[static]

Return the number of enumerators declared in CorrelatorTypeMod::CorrelatorType.

Returns:

an unsigned int.

static std::string CCorrelatorType::toString

(

const CorrelatorTypeMod::CorrelatorType &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 131 of file CCorrelatorType.h.

static std::string CCorrelatorType::toString

(

const CorrelatorTypeMod::CorrelatorType &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 131 of file CCorrelatorType.h.

static int CCorrelatorType::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

static int CCorrelatorType::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

static const std::string & CCorrelatorType::sFX [static]

Enumerators as strings.

A const string equal to "FX".

Definition at line 92 of file CCorrelatorType.h.

static const std::string & CCorrelatorType::sFXF [static]

A const string equal to "FXF".

Definition at line 96 of file CCorrelatorType.h.

static const std::string & CCorrelatorType::sXF [static]

A const string equal to "XF".

Definition at line 94 of file CCorrelatorType.h.

---

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

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