CDataScale Class Reference

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

#include <CDataScale.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 DataScaleMod::DataScale.
static std::string	name (const DataScaleMod::DataScale &e)
	Returns an enumerator as a string.
static std::string	toString (const DataScaleMod::DataScale &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static DataScaleMod::DataScale	newDataScale (const std::string &name)
	Create a DataScale enumeration object by specifying its name.
static DataScaleMod::DataScale	literal (const std::string &name)
static DataScaleMod::DataScale	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sK
	Enumerators as strings.
static const std::string &	sJY
static const std::string &	sCORRELATION
static const std::string &	sCORRELATION_COEFFICIENT
Private Member Functions
	CDataScale ()
	CDataScale (const CDataScale &)
CDataScale &	operator= (const CDataScale &)
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 DataScale.

Definition at line 87 of file CDataScale.h.

---

Constructor & Destructor Documentation

CDataScale::CDataScale

(

)

[private]

CDataScale::CDataScale

(

const CDataScale &

)

[private]

---

Member Function Documentation

static std::string CDataScale::badInt

(

unsigned int

i

)

[static, private]

static std::string CDataScale::badString

(

const std::string &

name

)

[static, private]

static DataScaleMod::DataScale CDataScale::from_int

(

unsigned int

i

)

[static]

Return a DataScale's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in DataScaleMod::DataScale.

Returns:

a DataScaleMod::DataScale's enumerator.

Exceptions:

a

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

static DataScaleMod::DataScale CDataScale::literal

(

const std::string &

name

)

[static]

Return a DataScale's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a DataScaleMod::DataScale's enumerator.

Exceptions:

a

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

static std::string CDataScale::name

(

const DataScaleMod::DataScale &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of DataScaleMod::DataScale.

Returns:

a string.

static const std::vector<std::string> CDataScale::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 DataScaleMod::DataScale CDataScale::newDataScale

(

const std::string &

name

)

[static]

Create a DataScale enumeration object by specifying its name.

CDataScale& CDataScale::operator=

(

const CDataScale &

)

[private]

static std::string CDataScale::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CDataScale::size

(

)

[static]

Return the number of enumerators declared in DataScaleMod::DataScale.

Returns:

an unsigned int.

static std::string CDataScale::toString

(

const DataScaleMod::DataScale &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 135 of file CDataScale.h.

static int CDataScale::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CDataScale::sCORRELATION [static]

A const string equal to "CORRELATION".

Definition at line 98 of file CDataScale.h.

const std::string& CDataScale::sCORRELATION_COEFFICIENT [static]

A const string equal to "CORRELATION_COEFFICIENT".

Definition at line 100 of file CDataScale.h.

const std::string& CDataScale::sJY [static]

A const string equal to "JY".

Definition at line 96 of file CDataScale.h.

const std::string& CDataScale::sK [static]

Enumerators as strings.

A const string equal to "K".

Definition at line 94 of file CDataScale.h.

---

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

• code/alma/Enumerations/CDataScale.h