CSidebandProcessingMode Class Reference

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

#include <CSidebandProcessingMode.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 SidebandProcessingModeMod::SidebandProcessingMode.
static std::string	name (const SidebandProcessingModeMod::SidebandProcessingMode &e)
	Returns an enumerator as a string.
static std::string	toString (const SidebandProcessingModeMod::SidebandProcessingMode &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static SidebandProcessingModeMod::SidebandProcessingMode	newSidebandProcessingMode (const std::string &name)
	Create a SidebandProcessingMode enumeration object by specifying its name.
static SidebandProcessingModeMod::SidebandProcessingMode	literal (const std::string &name)
static SidebandProcessingModeMod::SidebandProcessingMode	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sNONE
	Enumerators as strings.
static const std::string &	sPHASE_SWITCH_SEPARATION
static const std::string &	sFREQUENCY_OFFSET_SEPARATION
static const std::string &	sPHASE_SWITCH_REJECTION
static const std::string &	sFREQUENCY_OFFSET_REJECTION
Private Member Functions
	CSidebandProcessingMode ()
	CSidebandProcessingMode (const CSidebandProcessingMode &)
CSidebandProcessingMode &	operator= (const CSidebandProcessingMode &)
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 SidebandProcessingMode.

Definition at line 89 of file CSidebandProcessingMode.h.

---

Constructor & Destructor Documentation

CSidebandProcessingMode::CSidebandProcessingMode

(

)

[private]

CSidebandProcessingMode::CSidebandProcessingMode

(

const CSidebandProcessingMode &

)

[private]

---

Member Function Documentation

static std::string CSidebandProcessingMode::badInt

(

unsigned int

i

)

[static, private]

static std::string CSidebandProcessingMode::badString

(

const std::string &

name

)

[static, private]

static SidebandProcessingModeMod::SidebandProcessingMode CSidebandProcessingMode::from_int

(

unsigned int

i

)

[static]

Return a SidebandProcessingMode's enumerator given an unsigned int.

Parameters:

i

the index of the enumerator in SidebandProcessingModeMod::SidebandProcessingMode.

Returns:

a SidebandProcessingModeMod::SidebandProcessingMode's enumerator.

Exceptions:

a

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

static SidebandProcessingModeMod::SidebandProcessingMode CSidebandProcessingMode::literal

(

const std::string &

name

)

[static]

Return a SidebandProcessingMode's enumerator given a string.

Parameters:

name

the string representation of the enumerator.

Returns:

a SidebandProcessingModeMod::SidebandProcessingMode's enumerator.

Exceptions:

a

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

static std::string CSidebandProcessingMode::name

(

const SidebandProcessingModeMod::SidebandProcessingMode &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e

an enumerator of SidebandProcessingModeMod::SidebandProcessingMode.

Returns:

a string.

static const std::vector<std::string> CSidebandProcessingMode::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 SidebandProcessingModeMod::SidebandProcessingMode CSidebandProcessingMode::newSidebandProcessingMode

(

const std::string &

name

)

[static]

Create a SidebandProcessingMode enumeration object by specifying its name.

CSidebandProcessingMode& CSidebandProcessingMode::operator=

(

const CSidebandProcessingMode &

)

[private]

static std::string CSidebandProcessingMode::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CSidebandProcessingMode::size

(

)

[static]

Return the number of enumerators declared in SidebandProcessingModeMod::SidebandProcessingMode.

Returns:

an unsigned int.

static std::string CSidebandProcessingMode::toString

(

const SidebandProcessingModeMod::SidebandProcessingMode &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 139 of file CSidebandProcessingMode.h.

static int CSidebandProcessingMode::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

const std::string& CSidebandProcessingMode::sFREQUENCY_OFFSET_REJECTION [static]

A const string equal to "FREQUENCY_OFFSET_REJECTION".

Definition at line 104 of file CSidebandProcessingMode.h.

const std::string& CSidebandProcessingMode::sFREQUENCY_OFFSET_SEPARATION [static]

A const string equal to "FREQUENCY_OFFSET_SEPARATION".

Definition at line 100 of file CSidebandProcessingMode.h.

const std::string& CSidebandProcessingMode::sNONE [static]

Enumerators as strings.

A const string equal to "NONE".

Definition at line 96 of file CSidebandProcessingMode.h.

const std::string& CSidebandProcessingMode::sPHASE_SWITCH_REJECTION [static]

A const string equal to "PHASE_SWITCH_REJECTION".

Definition at line 102 of file CSidebandProcessingMode.h.

const std::string& CSidebandProcessingMode::sPHASE_SWITCH_SEPARATION [static]

A const string equal to "PHASE_SWITCH_SEPARATION".

Definition at line 98 of file CSidebandProcessingMode.h.

---

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

• code/alma/Enumerations/CSidebandProcessingMode.h