CDopplerTrackingMode Class Reference

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

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

Static Public Attributes
static const std::string &	sNONE
	Enumerators as strings. More...
static const std::string &	sCONTINUOUS
static const std::string &	sSCAN_BASED
static const std::string &	sSB_BASED

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

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

Definition at line 87 of file CDopplerTrackingMode.h.

Constructor & Destructor Documentation

CDopplerTrackingMode::CDopplerTrackingMode ( )

private

CDopplerTrackingMode::CDopplerTrackingMode ( const CDopplerTrackingMode &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static DopplerTrackingModeMod::DopplerTrackingMode CDopplerTrackingMode::from_int ( unsigned int  i )

static

Return a DopplerTrackingMode's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in DopplerTrackingModeMod::DopplerTrackingMode.

Returns

a DopplerTrackingModeMod::DopplerTrackingMode's enumerator.

Exceptions

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

static DopplerTrackingModeMod::DopplerTrackingMode CDopplerTrackingMode::literal ( const std::string &  name )

static

Return a DopplerTrackingMode's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a DopplerTrackingModeMod::DopplerTrackingMode's enumerator.

Exceptions

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

static std::string CDopplerTrackingMode::name ( const DopplerTrackingModeMod::DopplerTrackingMode &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of DopplerTrackingModeMod::DopplerTrackingMode.

Returns

a string.

static const std::vector<std::string> CDopplerTrackingMode::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 DopplerTrackingModeMod::DopplerTrackingMode CDopplerTrackingMode::newDopplerTrackingMode ( const std::string &  name )

static

Create a DopplerTrackingMode enumeration object by specifying its name.

CDopplerTrackingMode& CDopplerTrackingMode::operator= ( const CDopplerTrackingMode &  )

private

static std::string CDopplerTrackingMode::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CDopplerTrackingMode::size ( )

static

Return the number of enumerators declared in DopplerTrackingModeMod::DopplerTrackingMode.

Returns

an unsigned int.

static std::string CDopplerTrackingMode::toString ( const DopplerTrackingModeMod::DopplerTrackingMode &  f )

inlinestatic

Equivalent to the name method.

Definition at line 135 of file CDopplerTrackingMode.h.

static int CDopplerTrackingMode::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CDopplerTrackingMode::sCONTINUOUS

static

A const string equal to "CONTINUOUS".

Definition at line 96 of file CDopplerTrackingMode.h.

const std::string& CDopplerTrackingMode::sNONE

static

Enumerators as strings.

A const string equal to "NONE".

Definition at line 94 of file CDopplerTrackingMode.h.

const std::string& CDopplerTrackingMode::sSB_BASED

static

A const string equal to "SB_BASED".

Definition at line 100 of file CDopplerTrackingMode.h.

const std::string& CDopplerTrackingMode::sSCAN_BASED

static

A const string equal to "SCAN_BASED".

Definition at line 98 of file CDopplerTrackingMode.h.

---

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

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