CAntennaType Class Reference

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

#include <CAntennaType.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 AntennaTypeMod::AntennaType. More...
static std::string	name (const AntennaTypeMod::AntennaType &e)
	Returns an enumerator as a string. More...
static std::string	toString (const AntennaTypeMod::AntennaType &f)
	Equivalent to the name method. More...
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings. More...
static AntennaTypeMod::AntennaType	newAntennaType (const std::string &name)
	Create a AntennaType enumeration object by specifying its name. More...
static AntennaTypeMod::AntennaType	literal (const std::string &name)
static AntennaTypeMod::AntennaType	from_int (unsigned int i)

Static Public Attributes
static const std::string &	sGROUND_BASED
	Enumerators as strings. More...
static const std::string &	sSPACE_BASED
static const std::string &	sTRACKING_STN

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

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

Definition at line 85 of file CAntennaType.h.

Constructor & Destructor Documentation

CAntennaType::CAntennaType ( )

private

CAntennaType::CAntennaType ( const CAntennaType &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static AntennaTypeMod::AntennaType CAntennaType::from_int ( unsigned int  i )

static

Return a AntennaType's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in AntennaTypeMod::AntennaType.

Returns

a AntennaTypeMod::AntennaType's enumerator.

Exceptions

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

static AntennaTypeMod::AntennaType CAntennaType::literal ( const std::string &  name )

static

Return a AntennaType's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a AntennaTypeMod::AntennaType's enumerator.

Exceptions

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

static std::string CAntennaType::name ( const AntennaTypeMod::AntennaType &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of AntennaTypeMod::AntennaType.

Returns

a string.

static const std::vector<std::string> CAntennaType::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 AntennaTypeMod::AntennaType CAntennaType::newAntennaType ( const std::string &  name )

static

Create a AntennaType enumeration object by specifying its name.

CAntennaType& CAntennaType::operator= ( const CAntennaType &  )

private

static std::string CAntennaType::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CAntennaType::size ( )

static

Return the number of enumerators declared in AntennaTypeMod::AntennaType.

Returns

an unsigned int.

static std::string CAntennaType::toString ( const AntennaTypeMod::AntennaType &  f )

inlinestatic

Equivalent to the name method.

Definition at line 131 of file CAntennaType.h.

static int CAntennaType::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CAntennaType::sGROUND_BASED

static

Enumerators as strings.

A const string equal to "GROUND_BASED".

Definition at line 92 of file CAntennaType.h.

const std::string& CAntennaType::sSPACE_BASED

static

A const string equal to "SPACE_BASED".

Definition at line 94 of file CAntennaType.h.

const std::string& CAntennaType::sTRACKING_STN

static

A const string equal to "TRACKING_STN".

Definition at line 96 of file CAntennaType.h.

---

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

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