CSynthProf Class Reference

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

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

Definition at line 85 of file CSynthProf.h.

---

Constructor & Destructor Documentation

CSynthProf::CSynthProf

(

)

[private]

CSynthProf::CSynthProf

(

const CSynthProf &

)

[private]

---

Member Function Documentation

static std::string CSynthProf::badInt

(

unsigned int

i

)

[static, private]

static std::string CSynthProf::badString

(

const std::string &

name

)

[static, private]

static SynthProfMod::SynthProf CSynthProf::from_int

(

unsigned int

i

)

[static]

Return a SynthProf's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in SynthProfMod::SynthProf.

Returns:

a SynthProfMod::SynthProf's enumerator.

Exceptions:

a

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

static SynthProfMod::SynthProf CSynthProf::literal

(

const std::string &

name

)

[static]

Return a SynthProf's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a SynthProfMod::SynthProf's enumerator.

Exceptions:

a

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

static std::string CSynthProf::name

(

const SynthProfMod::SynthProf &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of SynthProfMod::SynthProf.

Returns:

a string.

static const std::vector<std::string> CSynthProf::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 SynthProfMod::SynthProf CSynthProf::newSynthProf

(

const std::string &

name

)

[static]

Create a SynthProf enumeration object by specifying its name.

CSynthProf& CSynthProf::operator=

(

const CSynthProf &

)

[private]

static std::string CSynthProf::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CSynthProf::size

(

)

[static]

Return the number of enumerators declared in SynthProfMod::SynthProf.

Returns:

an unsigned int.

static std::string CSynthProf::toString

(

const SynthProfMod::SynthProf &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 131 of file CSynthProf.h.

static int CSynthProf::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CSynthProf::sACA_CDP [static]

A const string equal to "ACA_CDP".

Definition at line 96 of file CSynthProf.h.

const std::string& CSynthProf::sACACORR [static]

A const string equal to "ACACORR".

Definition at line 94 of file CSynthProf.h.

const std::string& CSynthProf::sNOSYNTH [static]

Enumerators as strings.

A const string equal to "NOSYNTH".

Definition at line 92 of file CSynthProf.h.

---

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

• code/alma/Enumerations/CSynthProf.h