CAssociatedFieldNature Class Reference

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

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

Static Public Attributes
static const std::string &	sON
	Enumerators as strings. More...
static const std::string &	sOFF
static const std::string &	sPHASE_REFERENCE

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

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

Definition at line 85 of file CAssociatedFieldNature.h.

Constructor & Destructor Documentation

CAssociatedFieldNature::CAssociatedFieldNature ( )

private

CAssociatedFieldNature::CAssociatedFieldNature ( const CAssociatedFieldNature &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static AssociatedFieldNatureMod::AssociatedFieldNature CAssociatedFieldNature::from_int ( unsigned int  i )

static

Return a AssociatedFieldNature's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in AssociatedFieldNatureMod::AssociatedFieldNature.

Returns

a AssociatedFieldNatureMod::AssociatedFieldNature's enumerator.

Exceptions

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

static AssociatedFieldNatureMod::AssociatedFieldNature CAssociatedFieldNature::literal ( const std::string &  name )

static

Return a AssociatedFieldNature's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a AssociatedFieldNatureMod::AssociatedFieldNature's enumerator.

Exceptions

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

static std::string CAssociatedFieldNature::name ( const AssociatedFieldNatureMod::AssociatedFieldNature &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of AssociatedFieldNatureMod::AssociatedFieldNature.

Returns

a string.

static const std::vector<std::string> CAssociatedFieldNature::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 AssociatedFieldNatureMod::AssociatedFieldNature CAssociatedFieldNature::newAssociatedFieldNature ( const std::string &  name )

static

Create a AssociatedFieldNature enumeration object by specifying its name.

CAssociatedFieldNature& CAssociatedFieldNature::operator= ( const CAssociatedFieldNature &  )

private

static std::string CAssociatedFieldNature::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CAssociatedFieldNature::size ( )

static

Return the number of enumerators declared in AssociatedFieldNatureMod::AssociatedFieldNature.

Returns

an unsigned int.

static std::string CAssociatedFieldNature::toString ( const AssociatedFieldNatureMod::AssociatedFieldNature &  f )

inlinestatic

Equivalent to the name method.

Definition at line 131 of file CAssociatedFieldNature.h.

static int CAssociatedFieldNature::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CAssociatedFieldNature::sOFF

static

A const string equal to "OFF".

Definition at line 94 of file CAssociatedFieldNature.h.

const std::string& CAssociatedFieldNature::sON

static

Enumerators as strings.

A const string equal to "ON".

Definition at line 92 of file CAssociatedFieldNature.h.

const std::string& CAssociatedFieldNature::sPHASE_REFERENCE

static

A const string equal to "PHASE_REFERENCE".

Definition at line 96 of file CAssociatedFieldNature.h.

---

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

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