CNetSideband Class Reference

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

#include <CNetSideband.h>

Static Public Member Functions
static int	version ()
	Return the major version number as an int. More...
static std::string	revision ()
	Return the revision as a string. More...
static unsigned int	size ()
	Return the number of enumerators declared in NetSidebandMod::NetSideband. More...
static std::string	name (const NetSidebandMod::NetSideband &e)
	Returns an enumerator as a string. More...
static std::string	toString (const NetSidebandMod::NetSideband &f)
	Equivalent to the name method. More...
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings. More...
static NetSidebandMod::NetSideband	newNetSideband (const std::string &name)
	Create a NetSideband enumeration object by specifying its name. More...
static NetSidebandMod::NetSideband	literal (const std::string &name)
static NetSidebandMod::NetSideband	from_int (unsigned int i)

Static Public Attributes
static const std::string &	sNOSB
	Enumerators as strings. More...
static const std::string &	sLSB
static const std::string &	sUSB
static const std::string &	sDSB

Private Member Functions
	CNetSideband ()
	CNetSideband (const CNetSideband &)
CNetSideband &	operator= (const CNetSideband &)

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 NetSideband.

Definition at line 87 of file CNetSideband.h.

Constructor & Destructor Documentation

CNetSideband::CNetSideband ( )

private

CNetSideband::CNetSideband ( const CNetSideband &  )

private

Member Function Documentation

static std::string CNetSideband::badInt ( unsigned int  i )

staticprivate

static std::string CNetSideband::badString ( const std::string &  name )

staticprivate

static NetSidebandMod::NetSideband CNetSideband::from_int ( unsigned int  i )

static

Return a NetSideband's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in NetSidebandMod::NetSideband.

Returns

a NetSidebandMod::NetSideband's enumerator.

Exceptions

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

static NetSidebandMod::NetSideband CNetSideband::literal ( const std::string &  name )

static

Return a NetSideband's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a NetSidebandMod::NetSideband's enumerator.

Exceptions

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

static std::string CNetSideband::name ( const NetSidebandMod::NetSideband &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of NetSidebandMod::NetSideband.

Returns

a string.

static const std::vector<std::string> CNetSideband::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 NetSidebandMod::NetSideband CNetSideband::newNetSideband ( const std::string &  name )

static

Create a NetSideband enumeration object by specifying its name.

CNetSideband& CNetSideband::operator= ( const CNetSideband &  )

private

static std::string CNetSideband::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CNetSideband::size ( )

static

Return the number of enumerators declared in NetSidebandMod::NetSideband.

Returns

an unsigned int.

static std::string CNetSideband::toString ( const NetSidebandMod::NetSideband &  f )

inlinestatic

Equivalent to the name method.

Definition at line 135 of file CNetSideband.h.

static int CNetSideband::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CNetSideband::sDSB

static

A const string equal to "DSB".

Definition at line 100 of file CNetSideband.h.

const std::string& CNetSideband::sLSB

static

A const string equal to "LSB".

Definition at line 96 of file CNetSideband.h.

const std::string& CNetSideband::sNOSB

static

Enumerators as strings.

A const string equal to "NOSB".

Definition at line 94 of file CNetSideband.h.

const std::string& CNetSideband::sUSB

static

A const string equal to "USB".

Definition at line 98 of file CNetSideband.h.

---

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

• casa/code/alma/Enumerations/CNetSideband.h