CAccumMode Class Reference

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

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

Static Public Attributes
static const std::string &	sFAST
	Enumerators as strings. More...
static const std::string &	sNORMAL
static const std::string &	sUNDEFINED

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

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

Definition at line 85 of file CAccumMode.h.

Constructor & Destructor Documentation

CAccumMode::CAccumMode ( )

private

CAccumMode::CAccumMode ( const CAccumMode &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static AccumModeMod::AccumMode CAccumMode::from_int ( unsigned int  i )

static

Return a AccumMode's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in AccumModeMod::AccumMode.

Returns

a AccumModeMod::AccumMode's enumerator.

Exceptions

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

static AccumModeMod::AccumMode CAccumMode::literal ( const std::string &  name )

static

Return a AccumMode's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a AccumModeMod::AccumMode's enumerator.

Exceptions

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

static std::string CAccumMode::name ( const AccumModeMod::AccumMode &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of AccumModeMod::AccumMode.

Returns

a string.

static const std::vector<std::string> CAccumMode::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 AccumModeMod::AccumMode CAccumMode::newAccumMode ( const std::string &  name )

static

Create a AccumMode enumeration object by specifying its name.

CAccumMode& CAccumMode::operator= ( const CAccumMode &  )

private

static std::string CAccumMode::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CAccumMode::size ( )

static

Return the number of enumerators declared in AccumModeMod::AccumMode.

Returns

an unsigned int.

static std::string CAccumMode::toString ( const AccumModeMod::AccumMode &  f )

inlinestatic

Equivalent to the name method.

Definition at line 131 of file CAccumMode.h.

static int CAccumMode::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CAccumMode::sFAST

static

Enumerators as strings.

A const string equal to "FAST".

Definition at line 92 of file CAccumMode.h.

const std::string& CAccumMode::sNORMAL

static

A const string equal to "NORMAL".

Definition at line 94 of file CAccumMode.h.

const std::string& CAccumMode::sUNDEFINED

static

A const string equal to "UNDEFINED".

Definition at line 96 of file CAccumMode.h.

---

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

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