CSyscalMethod Class Reference

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

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

Static Public Attributes
static const std::string &	sTEMPERATURE_SCALE
	Enumerators as strings. More...
static const std::string &	sSKYDIP
static const std::string &	sSIDEBAND_RATIO

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

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

Definition at line 85 of file CSyscalMethod.h.

Constructor & Destructor Documentation

CSyscalMethod::CSyscalMethod ( )

private

CSyscalMethod::CSyscalMethod ( const CSyscalMethod &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static SyscalMethodMod::SyscalMethod CSyscalMethod::from_int ( unsigned int  i )

static

Return a SyscalMethod's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in SyscalMethodMod::SyscalMethod.

Returns

a SyscalMethodMod::SyscalMethod's enumerator.

Exceptions

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

static SyscalMethodMod::SyscalMethod CSyscalMethod::literal ( const std::string &  name )

static

Return a SyscalMethod's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a SyscalMethodMod::SyscalMethod's enumerator.

Exceptions

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

static std::string CSyscalMethod::name ( const SyscalMethodMod::SyscalMethod &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of SyscalMethodMod::SyscalMethod.

Returns

a string.

static const std::vector<std::string> CSyscalMethod::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 SyscalMethodMod::SyscalMethod CSyscalMethod::newSyscalMethod ( const std::string &  name )

static

Create a SyscalMethod enumeration object by specifying its name.

CSyscalMethod& CSyscalMethod::operator= ( const CSyscalMethod &  )

private

static std::string CSyscalMethod::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CSyscalMethod::size ( )

static

Return the number of enumerators declared in SyscalMethodMod::SyscalMethod.

Returns

an unsigned int.

static std::string CSyscalMethod::toString ( const SyscalMethodMod::SyscalMethod &  f )

inlinestatic

Equivalent to the name method.

Definition at line 131 of file CSyscalMethod.h.

static int CSyscalMethod::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CSyscalMethod::sSIDEBAND_RATIO

static

A const string equal to "SIDEBAND_RATIO".

Definition at line 96 of file CSyscalMethod.h.

const std::string& CSyscalMethod::sSKYDIP

static

A const string equal to "SKYDIP".

Definition at line 94 of file CSyscalMethod.h.

const std::string& CSyscalMethod::sTEMPERATURE_SCALE

static

Enumerators as strings.

A const string equal to "TEMPERATURE_SCALE".

Definition at line 92 of file CSyscalMethod.h.

---

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

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