CHolographyChannelType Class Reference

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

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

Static Public Attributes
static const std::string &	sQ2
	Enumerators as strings. More...
static const std::string &	sQR
static const std::string &	sQS
static const std::string &	sR2
static const std::string &	sRS
static const std::string &	sS2

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

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

Definition at line 91 of file CHolographyChannelType.h.

Constructor & Destructor Documentation

CHolographyChannelType::CHolographyChannelType ( )

private

CHolographyChannelType::CHolographyChannelType ( const CHolographyChannelType &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static HolographyChannelTypeMod::HolographyChannelType CHolographyChannelType::from_int ( unsigned int  i )

static

Return a HolographyChannelType's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in HolographyChannelTypeMod::HolographyChannelType.

Returns

a HolographyChannelTypeMod::HolographyChannelType's enumerator.

Exceptions

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

static HolographyChannelTypeMod::HolographyChannelType CHolographyChannelType::literal ( const std::string &  name )

static

Return a HolographyChannelType's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a HolographyChannelTypeMod::HolographyChannelType's enumerator.

Exceptions

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

static std::string CHolographyChannelType::name ( const HolographyChannelTypeMod::HolographyChannelType &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of HolographyChannelTypeMod::HolographyChannelType.

Returns

a string.

static const std::vector<std::string> CHolographyChannelType::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 HolographyChannelTypeMod::HolographyChannelType CHolographyChannelType::newHolographyChannelType ( const std::string &  name )

static

Create a HolographyChannelType enumeration object by specifying its name.

CHolographyChannelType& CHolographyChannelType::operator= ( const CHolographyChannelType &  )

private

static std::string CHolographyChannelType::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CHolographyChannelType::size ( )

static

Return the number of enumerators declared in HolographyChannelTypeMod::HolographyChannelType.

Returns

an unsigned int.

static std::string CHolographyChannelType::toString ( const HolographyChannelTypeMod::HolographyChannelType &  f )

inlinestatic

Equivalent to the name method.

Definition at line 143 of file CHolographyChannelType.h.

static int CHolographyChannelType::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CHolographyChannelType::sQ2

static

Enumerators as strings.

A const string equal to "Q2".

Definition at line 98 of file CHolographyChannelType.h.

const std::string& CHolographyChannelType::sQR

static

A const string equal to "QR".

Definition at line 100 of file CHolographyChannelType.h.

const std::string& CHolographyChannelType::sQS

static

A const string equal to "QS".

Definition at line 102 of file CHolographyChannelType.h.

const std::string& CHolographyChannelType::sR2

static

A const string equal to "R2".

Definition at line 104 of file CHolographyChannelType.h.

const std::string& CHolographyChannelType::sRS

static

A const string equal to "RS".

Definition at line 106 of file CHolographyChannelType.h.

const std::string& CHolographyChannelType::sS2

static

A const string equal to "S2".

Definition at line 108 of file CHolographyChannelType.h.

---

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

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