CSubscanIntent Class Reference

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

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

Static Public Attributes
static const std::string &	sON_SOURCE
	Enumerators as strings. More...
static const std::string &	sOFF_SOURCE
static const std::string &	sMIXED
static const std::string &	sREFERENCE
static const std::string &	sSCANNING
static const std::string &	sHOT
static const std::string &	sAMBIENT
static const std::string &	sSIGNAL
static const std::string &	sIMAGE
static const std::string &	sTEST
static const std::string &	sUNSPECIFIED

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

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

Definition at line 101 of file CSubscanIntent.h.

Constructor & Destructor Documentation

CSubscanIntent::CSubscanIntent ( )

private

CSubscanIntent::CSubscanIntent ( const CSubscanIntent &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static SubscanIntentMod::SubscanIntent CSubscanIntent::from_int ( unsigned int  i )

static

Return a SubscanIntent's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in SubscanIntentMod::SubscanIntent.

Returns

a SubscanIntentMod::SubscanIntent's enumerator.

Exceptions

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

static SubscanIntentMod::SubscanIntent CSubscanIntent::literal ( const std::string &  name )

static

Return a SubscanIntent's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a SubscanIntentMod::SubscanIntent's enumerator.

Exceptions

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

static std::string CSubscanIntent::name ( const SubscanIntentMod::SubscanIntent &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of SubscanIntentMod::SubscanIntent.

Returns

a string.

static const std::vector<std::string> CSubscanIntent::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 SubscanIntentMod::SubscanIntent CSubscanIntent::newSubscanIntent ( const std::string &  name )

static

Create a SubscanIntent enumeration object by specifying its name.

CSubscanIntent& CSubscanIntent::operator= ( const CSubscanIntent &  )

private

static std::string CSubscanIntent::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CSubscanIntent::size ( )

static

Return the number of enumerators declared in SubscanIntentMod::SubscanIntent.

Returns

an unsigned int.

static std::string CSubscanIntent::toString ( const SubscanIntentMod::SubscanIntent &  f )

inlinestatic

Equivalent to the name method.

Definition at line 163 of file CSubscanIntent.h.

static int CSubscanIntent::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CSubscanIntent::sAMBIENT

static

A const string equal to "AMBIENT".

Definition at line 120 of file CSubscanIntent.h.

const std::string& CSubscanIntent::sHOT

static

A const string equal to "HOT".

Definition at line 118 of file CSubscanIntent.h.

const std::string& CSubscanIntent::sIMAGE

static

A const string equal to "IMAGE".

Definition at line 124 of file CSubscanIntent.h.

const std::string& CSubscanIntent::sMIXED

static

A const string equal to "MIXED".

Definition at line 112 of file CSubscanIntent.h.

const std::string& CSubscanIntent::sOFF_SOURCE

static

A const string equal to "OFF_SOURCE".

Definition at line 110 of file CSubscanIntent.h.

const std::string& CSubscanIntent::sON_SOURCE

static

Enumerators as strings.

A const string equal to "ON_SOURCE".

Definition at line 108 of file CSubscanIntent.h.

const std::string& CSubscanIntent::sREFERENCE

static

A const string equal to "REFERENCE".

Definition at line 114 of file CSubscanIntent.h.

const std::string& CSubscanIntent::sSCANNING

static

A const string equal to "SCANNING".

Definition at line 116 of file CSubscanIntent.h.

const std::string& CSubscanIntent::sSIGNAL

static

A const string equal to "SIGNAL".

Definition at line 122 of file CSubscanIntent.h.

const std::string& CSubscanIntent::sTEST

static

A const string equal to "TEST".

Definition at line 126 of file CSubscanIntent.h.

const std::string& CSubscanIntent::sUNSPECIFIED

static

A const string equal to "UNSPECIFIED".

Definition at line 128 of file CSubscanIntent.h.

---

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

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