CWindowFunction Class Reference

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

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

Static Public Attributes
static const std::string &	sUNIFORM
	Enumerators as strings. More...
static const std::string &	sHANNING
static const std::string &	sHAMMING
static const std::string &	sBARTLETT
static const std::string &	sBLACKMANN
static const std::string &	sBLACKMANN_HARRIS
static const std::string &	sWELCH

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

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

Definition at line 93 of file CWindowFunction.h.

Constructor & Destructor Documentation

CWindowFunction::CWindowFunction ( )

private

CWindowFunction::CWindowFunction ( const CWindowFunction &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static WindowFunctionMod::WindowFunction CWindowFunction::from_int ( unsigned int  i )

static

Return a WindowFunction's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in WindowFunctionMod::WindowFunction.

Returns

a WindowFunctionMod::WindowFunction's enumerator.

Exceptions

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

static WindowFunctionMod::WindowFunction CWindowFunction::literal ( const std::string &  name )

static

Return a WindowFunction's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a WindowFunctionMod::WindowFunction's enumerator.

Exceptions

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

static std::string CWindowFunction::name ( const WindowFunctionMod::WindowFunction &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of WindowFunctionMod::WindowFunction.

Returns

a string.

static const std::vector<std::string> CWindowFunction::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 WindowFunctionMod::WindowFunction CWindowFunction::newWindowFunction ( const std::string &  name )

static

Create a WindowFunction enumeration object by specifying its name.

CWindowFunction& CWindowFunction::operator= ( const CWindowFunction &  )

private

static std::string CWindowFunction::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CWindowFunction::size ( )

static

Return the number of enumerators declared in WindowFunctionMod::WindowFunction.

Returns

an unsigned int.

static std::string CWindowFunction::toString ( const WindowFunctionMod::WindowFunction &  f )

inlinestatic

Equivalent to the name method.

Definition at line 147 of file CWindowFunction.h.

static int CWindowFunction::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CWindowFunction::sBARTLETT

static

A const string equal to "BARTLETT".

Definition at line 106 of file CWindowFunction.h.

const std::string& CWindowFunction::sBLACKMANN

static

A const string equal to "BLACKMANN".

Definition at line 108 of file CWindowFunction.h.

const std::string& CWindowFunction::sBLACKMANN_HARRIS

static

A const string equal to "BLACKMANN_HARRIS".

Definition at line 110 of file CWindowFunction.h.

const std::string& CWindowFunction::sHAMMING

static

A const string equal to "HAMMING".

Definition at line 104 of file CWindowFunction.h.

const std::string& CWindowFunction::sHANNING

static

A const string equal to "HANNING".

Definition at line 102 of file CWindowFunction.h.

const std::string& CWindowFunction::sUNIFORM

static

Enumerators as strings.

A const string equal to "UNIFORM".

Definition at line 100 of file CWindowFunction.h.

const std::string& CWindowFunction::sWELCH

static

A const string equal to "WELCH".

Definition at line 112 of file CWindowFunction.h.

---

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

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