CSpectralResolutionType Class Reference

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

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

Definition at line 85 of file CSpectralResolutionType.h.

---

Constructor & Destructor Documentation

CSpectralResolutionType::CSpectralResolutionType

(

)

[private]

CSpectralResolutionType::CSpectralResolutionType

(

const CSpectralResolutionType &

)

[private]

---

Member Function Documentation

static std::string CSpectralResolutionType::badInt

(

unsigned int

i

)

[static, private]

static std::string CSpectralResolutionType::badString

(

const std::string &

name

)

[static, private]

static SpectralResolutionTypeMod::SpectralResolutionType CSpectralResolutionType::from_int

(

unsigned int

i

)

[static]

Return a SpectralResolutionType's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in SpectralResolutionTypeMod::SpectralResolutionType.

Returns:

a SpectralResolutionTypeMod::SpectralResolutionType's enumerator.

Exceptions:

a

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

static SpectralResolutionTypeMod::SpectralResolutionType CSpectralResolutionType::literal

(

const std::string &

name

)

[static]

Return a SpectralResolutionType's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a SpectralResolutionTypeMod::SpectralResolutionType's enumerator.

Exceptions:

a

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

static std::string CSpectralResolutionType::name

(

const SpectralResolutionTypeMod::SpectralResolutionType &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of SpectralResolutionTypeMod::SpectralResolutionType.

Returns:

a string.

static const std::vector<std::string> CSpectralResolutionType::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 SpectralResolutionTypeMod::SpectralResolutionType CSpectralResolutionType::newSpectralResolutionType

(

const std::string &

name

)

[static]

Create a SpectralResolutionType enumeration object by specifying its name.

CSpectralResolutionType& CSpectralResolutionType::operator=

(

const CSpectralResolutionType &

)

[private]

static std::string CSpectralResolutionType::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CSpectralResolutionType::size

(

)

[static]

Return the number of enumerators declared in SpectralResolutionTypeMod::SpectralResolutionType.

Returns:

an unsigned int.

static std::string CSpectralResolutionType::toString

(

const SpectralResolutionTypeMod::SpectralResolutionType &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 131 of file CSpectralResolutionType.h.

static int CSpectralResolutionType::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CSpectralResolutionType::sBASEBAND_WIDE [static]

A const string equal to "BASEBAND_WIDE".

Definition at line 94 of file CSpectralResolutionType.h.

const std::string& CSpectralResolutionType::sCHANNEL_AVERAGE [static]

Enumerators as strings.

A const string equal to "CHANNEL_AVERAGE".

Definition at line 92 of file CSpectralResolutionType.h.

const std::string& CSpectralResolutionType::sFULL_RESOLUTION [static]

A const string equal to "FULL_RESOLUTION".

Definition at line 96 of file CSpectralResolutionType.h.

---

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

• code/alma/Enumerations/CSpectralResolutionType.h