CCorrelationBit Class Reference

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

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

Static Public Attributes
static const std::string &	sBITS_2x2
	Enumerators as strings. More...
static const std::string &	sBITS_3x3
static const std::string &	sBITS_4x4

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

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

Definition at line 85 of file CCorrelationBit.h.

Constructor & Destructor Documentation

CCorrelationBit::CCorrelationBit ( )

private

CCorrelationBit::CCorrelationBit ( const CCorrelationBit &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static CorrelationBitMod::CorrelationBit CCorrelationBit::from_int ( unsigned int  i )

static

Return a CorrelationBit's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in CorrelationBitMod::CorrelationBit.

Returns

a CorrelationBitMod::CorrelationBit's enumerator.

Exceptions

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

static CorrelationBitMod::CorrelationBit CCorrelationBit::literal ( const std::string &  name )

static

Return a CorrelationBit's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a CorrelationBitMod::CorrelationBit's enumerator.

Exceptions

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

static std::string CCorrelationBit::name ( const CorrelationBitMod::CorrelationBit &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of CorrelationBitMod::CorrelationBit.

Returns

a string.

static const std::vector<std::string> CCorrelationBit::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 CorrelationBitMod::CorrelationBit CCorrelationBit::newCorrelationBit ( const std::string &  name )

static

Create a CorrelationBit enumeration object by specifying its name.

CCorrelationBit& CCorrelationBit::operator= ( const CCorrelationBit &  )

private

static std::string CCorrelationBit::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CCorrelationBit::size ( )

static

Return the number of enumerators declared in CorrelationBitMod::CorrelationBit.

Returns

an unsigned int.

static std::string CCorrelationBit::toString ( const CorrelationBitMod::CorrelationBit &  f )

inlinestatic

Equivalent to the name method.

Definition at line 131 of file CCorrelationBit.h.

static int CCorrelationBit::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CCorrelationBit::sBITS_2x2

static

Enumerators as strings.

A const string equal to "BITS_2x2".

Definition at line 92 of file CCorrelationBit.h.

const std::string& CCorrelationBit::sBITS_3x3

static

A const string equal to "BITS_3x3".

Definition at line 94 of file CCorrelationBit.h.

const std::string& CCorrelationBit::sBITS_4x4

static

A const string equal to "BITS_4x4".

Definition at line 96 of file CCorrelationBit.h.

---

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

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