CAxisName Class Reference

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

#include <CAxisName.h>

List of all members.

Static Public Member Functions
static int	version ()
	Return the major version number as an int.
static std::string	revision ()
	Return the revision as a string.
static unsigned int	size ()
	Return the number of enumerators declared in AxisNameMod::AxisName.
static std::string	name (const AxisNameMod::AxisName &e)
	Returns an enumerator as a string.
static std::string	toString (const AxisNameMod::AxisName &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static AxisNameMod::AxisName	newAxisName (const std::string &name)
	Create a AxisName enumeration object by specifying its name.
static AxisNameMod::AxisName	literal (const std::string &name)
static AxisNameMod::AxisName	from_int (unsigned int i)
static int	version ()
	Return the major version number as an int.
static std::string	revision ()
	Return the revision as a string.
static unsigned int	size ()
	Return the number of enumerators declared in AxisNameMod::AxisName.
static std::string	name (const AxisNameMod::AxisName &e)
	Returns an enumerator as a string.
static std::string	toString (const AxisNameMod::AxisName &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static AxisNameMod::AxisName	newAxisName (const std::string &name)
	Create a AxisName enumeration object by specifying its name.
static AxisNameMod::AxisName	literal (const std::string &name)
static AxisNameMod::AxisName	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sTIM
	Enumerators as strings.
static const std::string &	sBAL
static const std::string &	sANT
static const std::string &	sBAB
static const std::string &	sSPW
static const std::string &	sSIB
static const std::string &	sSUB
static const std::string &	sBIN
static const std::string &	sAPC
static const std::string &	sSPP
static const std::string &	sPOL
static const std::string &	sSTO
static const std::string &	sHOL
Private Member Functions
	CAxisName ()
	CAxisName (const CAxisName &)
CAxisName &	operator= (const CAxisName &)
	CAxisName ()
	CAxisName (const CAxisName &)
CAxisName &	operator= (const CAxisName &)
Static Private Member Functions
static std::string	badString (const std::string &name)
static std::string	badInt (unsigned int i)
static std::string	badString (const std::string &name)
static std::string	badInt (unsigned int i)

---

Detailed Description

A helper class for the enumeration AxisName.

Definition at line 105 of file CAxisName.h.

---

Constructor & Destructor Documentation

CAxisName::CAxisName

(

)

[private]

CAxisName::CAxisName

(

const CAxisName &

)

[private]

CAxisName::CAxisName

(

)

[private]

CAxisName::CAxisName

(

const CAxisName &

)

[private]

---

Member Function Documentation

static std::string CAxisName::badInt

(

unsigned int

i

)

[static, private]

static std::string CAxisName::badInt

(

unsigned int

i

)

[static, private]

static std::string CAxisName::badString

(

const std::string &

name

)

[static, private]

static std::string CAxisName::badString

(

const std::string &

name

)

[static, private]

static AxisNameMod::AxisName CAxisName::from_int

(

unsigned int

i

)

[static]

Return a AxisName's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in AxisNameMod::AxisName.

Returns:

a AxisNameMod::AxisName's enumerator.

Exceptions:

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

static AxisNameMod::AxisName CAxisName::from_int

(

unsigned int

i

)

[static]

Return a AxisName's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in AxisNameMod::AxisName.

Returns:

a AxisNameMod::AxisName's enumerator.

Exceptions:

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

static AxisNameMod::AxisName CAxisName::literal

(

const std::string &

name

)

[static]

Return a AxisName's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a AxisNameMod::AxisName's enumerator.

Exceptions:

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

static AxisNameMod::AxisName CAxisName::literal

(

const std::string &

name

)

[static]

Return a AxisName's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a AxisNameMod::AxisName's enumerator.

Exceptions:

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

static std::string CAxisName::name

(

const AxisNameMod::AxisName &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of AxisNameMod::AxisName.

Returns:

a string.

static std::string CAxisName::name

(

const AxisNameMod::AxisName &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of AxisNameMod::AxisName.

Returns:

a string.

static const std::vector<std::string> CAxisName::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 const std::vector<std::string> CAxisName::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 AxisNameMod::AxisName CAxisName::newAxisName

(

const std::string &

name

)

[static]

Create a AxisName enumeration object by specifying its name.

static AxisNameMod::AxisName CAxisName::newAxisName

(

const std::string &

name

)

[static]

Create a AxisName enumeration object by specifying its name.

CAxisName& CAxisName::operator=

(

const CAxisName &

)

[private]

CAxisName& CAxisName::operator=

(

const CAxisName &

)

[private]

static std::string CAxisName::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static std::string CAxisName::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CAxisName::size

(

)

[static]

Return the number of enumerators declared in AxisNameMod::AxisName.

Returns:

an unsigned int.

static unsigned int CAxisName::size

(

)

[static]

Return the number of enumerators declared in AxisNameMod::AxisName.

Returns:

an unsigned int.

static std::string CAxisName::toString

(

const AxisNameMod::AxisName &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 171 of file CAxisName.h.

static std::string CAxisName::toString

(

const AxisNameMod::AxisName &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 171 of file CAxisName.h.

static int CAxisName::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

static int CAxisName::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

static const std::string & CAxisName::sANT [static]

A const string equal to "ANT".

Definition at line 116 of file CAxisName.h.

static const std::string & CAxisName::sAPC [static]

A const string equal to "APC".

Definition at line 128 of file CAxisName.h.

static const std::string & CAxisName::sBAB [static]

A const string equal to "BAB".

Definition at line 118 of file CAxisName.h.

static const std::string & CAxisName::sBAL [static]

A const string equal to "BAL".

Definition at line 114 of file CAxisName.h.

static const std::string & CAxisName::sBIN [static]

A const string equal to "BIN".

Definition at line 126 of file CAxisName.h.

static const std::string & CAxisName::sHOL [static]

A const string equal to "HOL".

Definition at line 136 of file CAxisName.h.

static const std::string & CAxisName::sPOL [static]

A const string equal to "POL".

Definition at line 132 of file CAxisName.h.

static const std::string & CAxisName::sSIB [static]

A const string equal to "SIB".

Definition at line 122 of file CAxisName.h.

static const std::string & CAxisName::sSPP [static]

A const string equal to "SPP".

Definition at line 130 of file CAxisName.h.

static const std::string & CAxisName::sSPW [static]

A const string equal to "SPW".

Definition at line 120 of file CAxisName.h.

static const std::string & CAxisName::sSTO [static]

A const string equal to "STO".

Definition at line 134 of file CAxisName.h.

static const std::string & CAxisName::sSUB [static]

A const string equal to "SUB".

Definition at line 124 of file CAxisName.h.

static const std::string & CAxisName::sTIM [static]

Enumerators as strings.

A const string equal to "TIM".

Definition at line 112 of file CAxisName.h.

---

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

• code/alma/Enumerations/CAxisName.h
• code/alma_v3/Enumerations/CAxisName.h