casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Static Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Member Functions | List of all members
CAxisName Class Reference

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

#include <CAxisName.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 AxisNameMod::AxisName. More...
 
static std::string name (const AxisNameMod::AxisName &e)
 Returns an enumerator as a string. More...
 
static std::string toString (const AxisNameMod::AxisName &f)
 Equivalent to the name method. More...
 
static const std::vector
< std::string > 
names ()
 Returns vector of all the enumerators as strings. More...
 
static AxisNameMod::AxisName newAxisName (const std::string &name)
 Create a AxisName enumeration object by specifying its name. More...
 
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. More...
 
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 &)
 
CAxisNameoperator= (const CAxisName &)
 

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

Definition at line 105 of file CAxisName.h.

Constructor & Destructor Documentation

CAxisName::CAxisName ( )
private
CAxisName::CAxisName ( const CAxisName )
private

Member Function Documentation

static std::string CAxisName::badInt ( unsigned int  i)
staticprivate
static std::string CAxisName::badString ( const std::string &  name)
staticprivate
static AxisNameMod::AxisName CAxisName::from_int ( unsigned int  i)
static

Return a AxisName's enumerator given an unsigned int.

Parameters
ithe index of the enumerator in AxisNameMod::AxisName.
Returns
a AxisNameMod::AxisName's enumerator.
Exceptions
astring 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
namethe string representation of the enumerator.
Returns
a AxisNameMod::AxisName's enumerator.
Exceptions
astring 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
ean 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 AxisNameMod::AxisName CAxisName::newAxisName ( const std::string &  name)
static

Create a AxisName enumeration object by specifying its name.

CAxisName& CAxisName::operator= ( const CAxisName )
private
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 std::string CAxisName::toString ( const AxisNameMod::AxisName &  f)
inlinestatic

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.

Member Data Documentation

const std::string& CAxisName::sANT
static

A const string equal to "ANT".

Definition at line 116 of file CAxisName.h.

const std::string& CAxisName::sAPC
static

A const string equal to "APC".

Definition at line 128 of file CAxisName.h.

const std::string& CAxisName::sBAB
static

A const string equal to "BAB".

Definition at line 118 of file CAxisName.h.

const std::string& CAxisName::sBAL
static

A const string equal to "BAL".

Definition at line 114 of file CAxisName.h.

const std::string& CAxisName::sBIN
static

A const string equal to "BIN".

Definition at line 126 of file CAxisName.h.

const std::string& CAxisName::sHOL
static

A const string equal to "HOL".

Definition at line 136 of file CAxisName.h.

const std::string& CAxisName::sPOL
static

A const string equal to "POL".

Definition at line 132 of file CAxisName.h.

const std::string& CAxisName::sSIB
static

A const string equal to "SIB".

Definition at line 122 of file CAxisName.h.

const std::string& CAxisName::sSPP
static

A const string equal to "SPP".

Definition at line 130 of file CAxisName.h.

const std::string& CAxisName::sSPW
static

A const string equal to "SPW".

Definition at line 120 of file CAxisName.h.

const std::string& CAxisName::sSTO
static

A const string equal to "STO".

Definition at line 134 of file CAxisName.h.

const std::string& CAxisName::sSUB
static

A const string equal to "SUB".

Definition at line 124 of file CAxisName.h.

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 file: