CReceiverSideband Class Reference

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

#include <CReceiverSideband.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 ReceiverSidebandMod::ReceiverSideband.
static std::string	name (const ReceiverSidebandMod::ReceiverSideband &e)
	Returns an enumerator as a string.
static std::string	toString (const ReceiverSidebandMod::ReceiverSideband &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static ReceiverSidebandMod::ReceiverSideband	newReceiverSideband (const std::string &name)
	Create a ReceiverSideband enumeration object by specifying its name.
static ReceiverSidebandMod::ReceiverSideband	literal (const std::string &name)
static ReceiverSidebandMod::ReceiverSideband	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 ReceiverSidebandMod::ReceiverSideband.
static std::string	name (const ReceiverSidebandMod::ReceiverSideband &e)
	Returns an enumerator as a string.
static std::string	toString (const ReceiverSidebandMod::ReceiverSideband &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static ReceiverSidebandMod::ReceiverSideband	newReceiverSideband (const std::string &name)
	Create a ReceiverSideband enumeration object by specifying its name.
static ReceiverSidebandMod::ReceiverSideband	literal (const std::string &name)
static ReceiverSidebandMod::ReceiverSideband	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sNOSB
	Enumerators as strings.
static const std::string &	sDSB
static const std::string &	sSSB
static const std::string &	sTSB
Private Member Functions
	CReceiverSideband ()
	CReceiverSideband (const CReceiverSideband &)
CReceiverSideband &	operator= (const CReceiverSideband &)
	CReceiverSideband ()
	CReceiverSideband (const CReceiverSideband &)
CReceiverSideband &	operator= (const CReceiverSideband &)
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 ReceiverSideband.

Definition at line 87 of file CReceiverSideband.h.

---

Constructor & Destructor Documentation

CReceiverSideband::CReceiverSideband

(

)

[private]

CReceiverSideband::CReceiverSideband

(

const CReceiverSideband &

)

[private]

CReceiverSideband::CReceiverSideband

(

)

[private]

CReceiverSideband::CReceiverSideband

(

const CReceiverSideband &

)

[private]

---

Member Function Documentation

static std::string CReceiverSideband::badInt

(

unsigned int

i

)

[static, private]

static std::string CReceiverSideband::badInt

(

unsigned int

i

)

[static, private]

static std::string CReceiverSideband::badString

(

const std::string &

name

)

[static, private]

static std::string CReceiverSideband::badString

(

const std::string &

name

)

[static, private]

static ReceiverSidebandMod::ReceiverSideband CReceiverSideband::from_int

(

unsigned int

i

)

[static]

Return a ReceiverSideband's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in ReceiverSidebandMod::ReceiverSideband.

Returns:

a ReceiverSidebandMod::ReceiverSideband's enumerator.

Exceptions:

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

static ReceiverSidebandMod::ReceiverSideband CReceiverSideband::from_int

(

unsigned int

i

)

[static]

Return a ReceiverSideband's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in ReceiverSidebandMod::ReceiverSideband.

Returns:

a ReceiverSidebandMod::ReceiverSideband's enumerator.

Exceptions:

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

static ReceiverSidebandMod::ReceiverSideband CReceiverSideband::literal

(

const std::string &

name

)

[static]

Return a ReceiverSideband's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a ReceiverSidebandMod::ReceiverSideband's enumerator.

Exceptions:

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

static ReceiverSidebandMod::ReceiverSideband CReceiverSideband::literal

(

const std::string &

name

)

[static]

Return a ReceiverSideband's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a ReceiverSidebandMod::ReceiverSideband's enumerator.

Exceptions:

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

static std::string CReceiverSideband::name

(

const ReceiverSidebandMod::ReceiverSideband &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of ReceiverSidebandMod::ReceiverSideband.

Returns:

a string.

static std::string CReceiverSideband::name

(

const ReceiverSidebandMod::ReceiverSideband &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of ReceiverSidebandMod::ReceiverSideband.

Returns:

a string.

static const std::vector<std::string> CReceiverSideband::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> CReceiverSideband::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 ReceiverSidebandMod::ReceiverSideband CReceiverSideband::newReceiverSideband

(

const std::string &

name

)

[static]

Create a ReceiverSideband enumeration object by specifying its name.

static ReceiverSidebandMod::ReceiverSideband CReceiverSideband::newReceiverSideband

(

const std::string &

name

)

[static]

Create a ReceiverSideband enumeration object by specifying its name.

CReceiverSideband& CReceiverSideband::operator=

(

const CReceiverSideband &

)

[private]

CReceiverSideband& CReceiverSideband::operator=

(

const CReceiverSideband &

)

[private]

static std::string CReceiverSideband::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static std::string CReceiverSideband::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CReceiverSideband::size

(

)

[static]

Return the number of enumerators declared in ReceiverSidebandMod::ReceiverSideband.

Returns:

an unsigned int.

static unsigned int CReceiverSideband::size

(

)

[static]

Return the number of enumerators declared in ReceiverSidebandMod::ReceiverSideband.

Returns:

an unsigned int.

static std::string CReceiverSideband::toString

(

const ReceiverSidebandMod::ReceiverSideband &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 135 of file CReceiverSideband.h.

static std::string CReceiverSideband::toString

(

const ReceiverSidebandMod::ReceiverSideband &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 135 of file CReceiverSideband.h.

static int CReceiverSideband::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

static int CReceiverSideband::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

static const std::string & CReceiverSideband::sDSB [static]

A const string equal to "DSB".

Definition at line 96 of file CReceiverSideband.h.

static const std::string & CReceiverSideband::sNOSB [static]

Enumerators as strings.

A const string equal to "NOSB".

Definition at line 94 of file CReceiverSideband.h.

static const std::string & CReceiverSideband::sSSB [static]

A const string equal to "SSB".

Definition at line 98 of file CReceiverSideband.h.

static const std::string & CReceiverSideband::sTSB [static]

A const string equal to "TSB".

Definition at line 100 of file CReceiverSideband.h.

---

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

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