CPointingMethod Class Reference

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

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

Static Public Attributes
static const std::string &	sTHREE_POINT
	Enumerators as strings. More...
static const std::string &	sFOUR_POINT
static const std::string &	sFIVE_POINT
static const std::string &	sCROSS
static const std::string &	sCIRCLE
static const std::string &	sHOLOGRAPHY

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

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

Definition at line 91 of file CPointingMethod.h.

Constructor & Destructor Documentation

CPointingMethod::CPointingMethod ( )

private

CPointingMethod::CPointingMethod ( const CPointingMethod &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static PointingMethodMod::PointingMethod CPointingMethod::from_int ( unsigned int  i )

static

Return a PointingMethod's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in PointingMethodMod::PointingMethod.

Returns

a PointingMethodMod::PointingMethod's enumerator.

Exceptions

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

static PointingMethodMod::PointingMethod CPointingMethod::literal ( const std::string &  name )

static

Return a PointingMethod's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a PointingMethodMod::PointingMethod's enumerator.

Exceptions

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

static std::string CPointingMethod::name ( const PointingMethodMod::PointingMethod &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of PointingMethodMod::PointingMethod.

Returns

a string.

static const std::vector<std::string> CPointingMethod::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 PointingMethodMod::PointingMethod CPointingMethod::newPointingMethod ( const std::string &  name )

static

Create a PointingMethod enumeration object by specifying its name.

CPointingMethod& CPointingMethod::operator= ( const CPointingMethod &  )

private

static std::string CPointingMethod::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CPointingMethod::size ( )

static

Return the number of enumerators declared in PointingMethodMod::PointingMethod.

Returns

an unsigned int.

static std::string CPointingMethod::toString ( const PointingMethodMod::PointingMethod &  f )

inlinestatic

Equivalent to the name method.

Definition at line 143 of file CPointingMethod.h.

static int CPointingMethod::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CPointingMethod::sCIRCLE

static

A const string equal to "CIRCLE".

Definition at line 106 of file CPointingMethod.h.

const std::string& CPointingMethod::sCROSS

static

A const string equal to "CROSS".

Definition at line 104 of file CPointingMethod.h.

const std::string& CPointingMethod::sFIVE_POINT

static

A const string equal to "FIVE_POINT".

Definition at line 102 of file CPointingMethod.h.

const std::string& CPointingMethod::sFOUR_POINT

static

A const string equal to "FOUR_POINT".

Definition at line 100 of file CPointingMethod.h.

const std::string& CPointingMethod::sHOLOGRAPHY

static

A const string equal to "HOLOGRAPHY".

Definition at line 108 of file CPointingMethod.h.

const std::string& CPointingMethod::sTHREE_POINT

static

Enumerators as strings.

A const string equal to "THREE_POINT".

Definition at line 98 of file CPointingMethod.h.

---

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

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