CFilterMode Class Reference

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

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

Static Public Attributes
static const std::string &	sFILTER_NA
	Enumerators as strings. More...
static const std::string &	sFILTER_TDM
static const std::string &	sFILTER_TFB
static const std::string &	sUNDEFINED

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

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

Definition at line 87 of file CFilterMode.h.

Constructor & Destructor Documentation

CFilterMode::CFilterMode ( )

private

CFilterMode::CFilterMode ( const CFilterMode &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static FilterModeMod::FilterMode CFilterMode::from_int ( unsigned int  i )

static

Return a FilterMode's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in FilterModeMod::FilterMode.

Returns

a FilterModeMod::FilterMode's enumerator.

Exceptions

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

static FilterModeMod::FilterMode CFilterMode::literal ( const std::string &  name )

static

Return a FilterMode's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a FilterModeMod::FilterMode's enumerator.

Exceptions

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

static std::string CFilterMode::name ( const FilterModeMod::FilterMode &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of FilterModeMod::FilterMode.

Returns

a string.

static const std::vector<std::string> CFilterMode::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 FilterModeMod::FilterMode CFilterMode::newFilterMode ( const std::string &  name )

static

Create a FilterMode enumeration object by specifying its name.

CFilterMode& CFilterMode::operator= ( const CFilterMode &  )

private

static std::string CFilterMode::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CFilterMode::size ( )

static

Return the number of enumerators declared in FilterModeMod::FilterMode.

Returns

an unsigned int.

static std::string CFilterMode::toString ( const FilterModeMod::FilterMode &  f )

inlinestatic

Equivalent to the name method.

Definition at line 135 of file CFilterMode.h.

static int CFilterMode::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CFilterMode::sFILTER_NA

static

Enumerators as strings.

A const string equal to "FILTER_NA".

Definition at line 94 of file CFilterMode.h.

const std::string& CFilterMode::sFILTER_TDM

static

A const string equal to "FILTER_TDM".

Definition at line 96 of file CFilterMode.h.

const std::string& CFilterMode::sFILTER_TFB

static

A const string equal to "FILTER_TFB".

Definition at line 98 of file CFilterMode.h.

const std::string& CFilterMode::sUNDEFINED

static

A const string equal to "UNDEFINED".

Definition at line 100 of file CFilterMode.h.

---

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

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