CInvalidatingCondition Class Reference

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

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

Static Public Attributes
static const std::string &	sANTENNA_DISCONNECT
	Enumerators as strings. More...
static const std::string &	sANTENNA_MOVE
static const std::string &	sANTENNA_POWER_DOWN
static const std::string &	sRECEIVER_EXCHANGE
static const std::string &	sRECEIVER_POWER_DOWN

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

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

Definition at line 89 of file CInvalidatingCondition.h.

Constructor & Destructor Documentation

CInvalidatingCondition::CInvalidatingCondition ( )

private

CInvalidatingCondition::CInvalidatingCondition ( const CInvalidatingCondition &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static InvalidatingConditionMod::InvalidatingCondition CInvalidatingCondition::from_int ( unsigned int  i )

static

Return a InvalidatingCondition's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in InvalidatingConditionMod::InvalidatingCondition.

Returns

a InvalidatingConditionMod::InvalidatingCondition's enumerator.

Exceptions

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

static InvalidatingConditionMod::InvalidatingCondition CInvalidatingCondition::literal ( const std::string &  name )

static

Return a InvalidatingCondition's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a InvalidatingConditionMod::InvalidatingCondition's enumerator.

Exceptions

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

static std::string CInvalidatingCondition::name ( const InvalidatingConditionMod::InvalidatingCondition &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of InvalidatingConditionMod::InvalidatingCondition.

Returns

a string.

static const std::vector<std::string> CInvalidatingCondition::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 InvalidatingConditionMod::InvalidatingCondition CInvalidatingCondition::newInvalidatingCondition ( const std::string &  name )

static

Create a InvalidatingCondition enumeration object by specifying its name.

CInvalidatingCondition& CInvalidatingCondition::operator= ( const CInvalidatingCondition &  )

private

static std::string CInvalidatingCondition::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CInvalidatingCondition::size ( )

static

Return the number of enumerators declared in InvalidatingConditionMod::InvalidatingCondition.

Returns

an unsigned int.

static std::string CInvalidatingCondition::toString ( const InvalidatingConditionMod::InvalidatingCondition &  f )

inlinestatic

Equivalent to the name method.

Definition at line 139 of file CInvalidatingCondition.h.

static int CInvalidatingCondition::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CInvalidatingCondition::sANTENNA_DISCONNECT

static

Enumerators as strings.

A const string equal to "ANTENNA_DISCONNECT".

Definition at line 96 of file CInvalidatingCondition.h.

const std::string& CInvalidatingCondition::sANTENNA_MOVE

static

A const string equal to "ANTENNA_MOVE".

Definition at line 98 of file CInvalidatingCondition.h.

const std::string& CInvalidatingCondition::sANTENNA_POWER_DOWN

static

A const string equal to "ANTENNA_POWER_DOWN".

Definition at line 100 of file CInvalidatingCondition.h.

const std::string& CInvalidatingCondition::sRECEIVER_EXCHANGE

static

A const string equal to "RECEIVER_EXCHANGE".

Definition at line 102 of file CInvalidatingCondition.h.

const std::string& CInvalidatingCondition::sRECEIVER_POWER_DOWN

static

A const string equal to "RECEIVER_POWER_DOWN".

Definition at line 104 of file CInvalidatingCondition.h.

---

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

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