CFocusMethod Class Reference

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

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

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

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

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

Definition at line 85 of file CFocusMethod.h.

Constructor & Destructor Documentation

CFocusMethod::CFocusMethod ( )

private

CFocusMethod::CFocusMethod ( const CFocusMethod &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static FocusMethodMod::FocusMethod CFocusMethod::from_int ( unsigned int  i )

static

Return a FocusMethod's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in FocusMethodMod::FocusMethod.

Returns

a FocusMethodMod::FocusMethod's enumerator.

Exceptions

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

static FocusMethodMod::FocusMethod CFocusMethod::literal ( const std::string &  name )

static

Return a FocusMethod's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a FocusMethodMod::FocusMethod's enumerator.

Exceptions

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

static std::string CFocusMethod::name ( const FocusMethodMod::FocusMethod &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of FocusMethodMod::FocusMethod.

Returns

a string.

static const std::vector<std::string> CFocusMethod::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 FocusMethodMod::FocusMethod CFocusMethod::newFocusMethod ( const std::string &  name )

static

Create a FocusMethod enumeration object by specifying its name.

CFocusMethod& CFocusMethod::operator= ( const CFocusMethod &  )

private

static std::string CFocusMethod::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CFocusMethod::size ( )

static

Return the number of enumerators declared in FocusMethodMod::FocusMethod.

Returns

an unsigned int.

static std::string CFocusMethod::toString ( const FocusMethodMod::FocusMethod &  f )

inlinestatic

Equivalent to the name method.

Definition at line 131 of file CFocusMethod.h.

static int CFocusMethod::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CFocusMethod::sFIVE_POINT

static

A const string equal to "FIVE_POINT".

Definition at line 94 of file CFocusMethod.h.

const std::string& CFocusMethod::sHOLOGRAPHY

static

A const string equal to "HOLOGRAPHY".

Definition at line 96 of file CFocusMethod.h.

const std::string& CFocusMethod::sTHREE_POINT

static

Enumerators as strings.

A const string equal to "THREE_POINT".

Definition at line 92 of file CFocusMethod.h.

---

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

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