CCorrelationMode Class Reference

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

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

Static Public Attributes
static const std::string &	sCROSS_ONLY
	Enumerators as strings. More...
static const std::string &	sAUTO_ONLY
static const std::string &	sCROSS_AND_AUTO

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

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

Definition at line 85 of file CCorrelationMode.h.

Constructor & Destructor Documentation

CCorrelationMode::CCorrelationMode ( )

private

CCorrelationMode::CCorrelationMode ( const CCorrelationMode &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static CorrelationModeMod::CorrelationMode CCorrelationMode::from_int ( unsigned int  i )

static

Return a CorrelationMode's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in CorrelationModeMod::CorrelationMode.

Returns

a CorrelationModeMod::CorrelationMode's enumerator.

Exceptions

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

static CorrelationModeMod::CorrelationMode CCorrelationMode::literal ( const std::string &  name )

static

Return a CorrelationMode's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a CorrelationModeMod::CorrelationMode's enumerator.

Exceptions

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

static std::string CCorrelationMode::name ( const CorrelationModeMod::CorrelationMode &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of CorrelationModeMod::CorrelationMode.

Returns

a string.

static const std::vector<std::string> CCorrelationMode::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 CorrelationModeMod::CorrelationMode CCorrelationMode::newCorrelationMode ( const std::string &  name )

static

Create a CorrelationMode enumeration object by specifying its name.

CCorrelationMode& CCorrelationMode::operator= ( const CCorrelationMode &  )

private

static std::string CCorrelationMode::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CCorrelationMode::size ( )

static

Return the number of enumerators declared in CorrelationModeMod::CorrelationMode.

Returns

an unsigned int.

static std::string CCorrelationMode::toString ( const CorrelationModeMod::CorrelationMode &  f )

inlinestatic

Equivalent to the name method.

Definition at line 131 of file CCorrelationMode.h.

static int CCorrelationMode::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CCorrelationMode::sAUTO_ONLY

static

A const string equal to "AUTO_ONLY".

Definition at line 94 of file CCorrelationMode.h.

const std::string& CCorrelationMode::sCROSS_AND_AUTO

static

A const string equal to "CROSS_AND_AUTO".

Definition at line 96 of file CCorrelationMode.h.

const std::string& CCorrelationMode::sCROSS_ONLY

static

Enumerators as strings.

A const string equal to "CROSS_ONLY".

Definition at line 92 of file CCorrelationMode.h.

---

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

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