CCalCurveType Class Reference

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

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

Definition at line 85 of file CCalCurveType.h.

---

Constructor & Destructor Documentation

CCalCurveType::CCalCurveType

(

)

[private]

CCalCurveType::CCalCurveType

(

const CCalCurveType &

)

[private]

CCalCurveType::CCalCurveType

(

)

[private]

CCalCurveType::CCalCurveType

(

const CCalCurveType &

)

[private]

---

Member Function Documentation

static std::string CCalCurveType::badInt

(

unsigned int

i

)

[static, private]

static std::string CCalCurveType::badInt

(

unsigned int

i

)

[static, private]

static std::string CCalCurveType::badString

(

const std::string &

name

)

[static, private]

static std::string CCalCurveType::badString

(

const std::string &

name

)

[static, private]

static CalCurveTypeMod::CalCurveType CCalCurveType::from_int

(

unsigned int

i

)

[static]

Return a CalCurveType's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in CalCurveTypeMod::CalCurveType.

Returns:

a CalCurveTypeMod::CalCurveType's enumerator.

Exceptions:

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

static CalCurveTypeMod::CalCurveType CCalCurveType::from_int

(

unsigned int

i

)

[static]

Return a CalCurveType's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in CalCurveTypeMod::CalCurveType.

Returns:

a CalCurveTypeMod::CalCurveType's enumerator.

Exceptions:

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

static CalCurveTypeMod::CalCurveType CCalCurveType::literal

(

const std::string &

name

)

[static]

Return a CalCurveType's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a CalCurveTypeMod::CalCurveType's enumerator.

Exceptions:

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

static CalCurveTypeMod::CalCurveType CCalCurveType::literal

(

const std::string &

name

)

[static]

Return a CalCurveType's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a CalCurveTypeMod::CalCurveType's enumerator.

Exceptions:

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

static std::string CCalCurveType::name

(

const CalCurveTypeMod::CalCurveType &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of CalCurveTypeMod::CalCurveType.

Returns:

a string.

static std::string CCalCurveType::name

(

const CalCurveTypeMod::CalCurveType &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of CalCurveTypeMod::CalCurveType.

Returns:

a string.

static const std::vector<std::string> CCalCurveType::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> CCalCurveType::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 CalCurveTypeMod::CalCurveType CCalCurveType::newCalCurveType

(

const std::string &

name

)

[static]

Create a CalCurveType enumeration object by specifying its name.

static CalCurveTypeMod::CalCurveType CCalCurveType::newCalCurveType

(

const std::string &

name

)

[static]

Create a CalCurveType enumeration object by specifying its name.

CCalCurveType& CCalCurveType::operator=

(

const CCalCurveType &

)

[private]

CCalCurveType& CCalCurveType::operator=

(

const CCalCurveType &

)

[private]

static std::string CCalCurveType::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static std::string CCalCurveType::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CCalCurveType::size

(

)

[static]

Return the number of enumerators declared in CalCurveTypeMod::CalCurveType.

Returns:

an unsigned int.

static unsigned int CCalCurveType::size

(

)

[static]

Return the number of enumerators declared in CalCurveTypeMod::CalCurveType.

Returns:

an unsigned int.

static std::string CCalCurveType::toString

(

const CalCurveTypeMod::CalCurveType &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 131 of file CCalCurveType.h.

static std::string CCalCurveType::toString

(

const CalCurveTypeMod::CalCurveType &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 131 of file CCalCurveType.h.

static int CCalCurveType::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

static int CCalCurveType::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

static const std::string & CCalCurveType::sAMPLITUDE [static]

Enumerators as strings.

A const string equal to "AMPLITUDE".

Definition at line 92 of file CCalCurveType.h.

static const std::string & CCalCurveType::sPHASE [static]

A const string equal to "PHASE".

Definition at line 94 of file CCalCurveType.h.

static const std::string & CCalCurveType::sUNDEFINED [static]

A const string equal to "UNDEFINED".

Definition at line 96 of file CCalCurveType.h.

---

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

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