CPolarizationType Class Reference

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

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

Static Public Attributes
static const std::string &	sR
	Enumerators as strings. More...
static const std::string &	sL
static const std::string &	sX
static const std::string &	sY
static const std::string &	sBOTH

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

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

Definition at line 90 of file CPolarizationType.h.

Constructor & Destructor Documentation

CPolarizationType::CPolarizationType ( )

private

CPolarizationType::CPolarizationType ( const CPolarizationType &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static PolarizationTypeMod::PolarizationType CPolarizationType::from_int ( unsigned int  i )

static

Return a PolarizationType's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in PolarizationTypeMod::PolarizationType.

Returns

a PolarizationTypeMod::PolarizationType's enumerator.

Exceptions

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

static PolarizationTypeMod::PolarizationType CPolarizationType::literal ( const std::string &  name )

static

Return a PolarizationType's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a PolarizationTypeMod::PolarizationType's enumerator.

Exceptions

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

static std::string CPolarizationType::name ( const PolarizationTypeMod::PolarizationType &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of PolarizationTypeMod::PolarizationType.

Returns

a string.

static const std::vector<std::string> CPolarizationType::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 PolarizationTypeMod::PolarizationType CPolarizationType::newPolarizationType ( const std::string &  name )

static

Create a PolarizationType enumeration object by specifying its name.

CPolarizationType& CPolarizationType::operator= ( const CPolarizationType &  )

private

static std::string CPolarizationType::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CPolarizationType::size ( )

static

Return the number of enumerators declared in PolarizationTypeMod::PolarizationType.

Returns

an unsigned int.

static std::string CPolarizationType::toString ( const PolarizationTypeMod::PolarizationType &  f )

inlinestatic

Equivalent to the name method.

Definition at line 140 of file CPolarizationType.h.

static int CPolarizationType::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CPolarizationType::sBOTH

static

A const string equal to "BOTH".

Definition at line 105 of file CPolarizationType.h.

const std::string& CPolarizationType::sL

static

A const string equal to "L".

Definition at line 99 of file CPolarizationType.h.

const std::string& CPolarizationType::sR

static

Enumerators as strings.

A const string equal to "R".

Definition at line 97 of file CPolarizationType.h.

const std::string& CPolarizationType::sX

static

A const string equal to "X".

Definition at line 101 of file CPolarizationType.h.

const std::string& CPolarizationType::sY

static

A const string equal to "Y".

Definition at line 103 of file CPolarizationType.h.

---

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

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