CStationType Class Reference

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

#include <CStationType.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 StationTypeMod::StationType.
static std::string	name (const StationTypeMod::StationType &e)
	Returns an enumerator as a string.
static std::string	toString (const StationTypeMod::StationType &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static StationTypeMod::StationType	newStationType (const std::string &name)
	Create a StationType enumeration object by specifying its name.
static StationTypeMod::StationType	literal (const std::string &name)
static StationTypeMod::StationType	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 StationTypeMod::StationType.
static std::string	name (const StationTypeMod::StationType &e)
	Returns an enumerator as a string.
static std::string	toString (const StationTypeMod::StationType &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static StationTypeMod::StationType	newStationType (const std::string &name)
	Create a StationType enumeration object by specifying its name.
static StationTypeMod::StationType	literal (const std::string &name)
static StationTypeMod::StationType	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sANTENNA_PAD
	Enumerators as strings.
static const std::string &	sMAINTENANCE_PAD
static const std::string &	sWEATHER_STATION
Private Member Functions
	CStationType ()
	CStationType (const CStationType &)
CStationType &	operator= (const CStationType &)
	CStationType ()
	CStationType (const CStationType &)
CStationType &	operator= (const CStationType &)
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 StationType.

Definition at line 85 of file CStationType.h.

---

Constructor & Destructor Documentation

CStationType::CStationType

(

)

[private]

CStationType::CStationType

(

const CStationType &

)

[private]

CStationType::CStationType

(

)

[private]

CStationType::CStationType

(

const CStationType &

)

[private]

---

Member Function Documentation

static std::string CStationType::badInt

(

unsigned int

i

)

[static, private]

static std::string CStationType::badInt

(

unsigned int

i

)

[static, private]

static std::string CStationType::badString

(

const std::string &

name

)

[static, private]

static std::string CStationType::badString

(

const std::string &

name

)

[static, private]

static StationTypeMod::StationType CStationType::from_int

(

unsigned int

i

)

[static]

Return a StationType's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in StationTypeMod::StationType.

Returns:

a StationTypeMod::StationType's enumerator.

Exceptions:

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

static StationTypeMod::StationType CStationType::from_int

(

unsigned int

i

)

[static]

Return a StationType's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in StationTypeMod::StationType.

Returns:

a StationTypeMod::StationType's enumerator.

Exceptions:

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

static StationTypeMod::StationType CStationType::literal

(

const std::string &

name

)

[static]

Return a StationType's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a StationTypeMod::StationType's enumerator.

Exceptions:

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

static StationTypeMod::StationType CStationType::literal

(

const std::string &

name

)

[static]

Return a StationType's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:

a StationTypeMod::StationType's enumerator.

Exceptions:

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

static std::string CStationType::name

(

const StationTypeMod::StationType &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of StationTypeMod::StationType.

Returns:

a string.

static std::string CStationType::name

(

const StationTypeMod::StationType &

e

)

[static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of StationTypeMod::StationType.

Returns:

a string.

static const std::vector<std::string> CStationType::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> CStationType::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 StationTypeMod::StationType CStationType::newStationType

(

const std::string &

name

)

[static]

Create a StationType enumeration object by specifying its name.

static StationTypeMod::StationType CStationType::newStationType

(

const std::string &

name

)

[static]

Create a StationType enumeration object by specifying its name.

CStationType& CStationType::operator=

(

const CStationType &

)

[private]

CStationType& CStationType::operator=

(

const CStationType &

)

[private]

static std::string CStationType::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static std::string CStationType::revision

(

)

[static]

Return the revision as a string.

Returns:

a string

static unsigned int CStationType::size

(

)

[static]

Return the number of enumerators declared in StationTypeMod::StationType.

Returns:

an unsigned int.

static unsigned int CStationType::size

(

)

[static]

Return the number of enumerators declared in StationTypeMod::StationType.

Returns:

an unsigned int.

static std::string CStationType::toString

(

const StationTypeMod::StationType &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 131 of file CStationType.h.

static std::string CStationType::toString

(

const StationTypeMod::StationType &

f

)

[inline, static]

Equivalent to the name method.

Definition at line 131 of file CStationType.h.

static int CStationType::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

static int CStationType::version

(

)

[static]

Return the major version number as an int.

Returns:

an int.

---

Member Data Documentation

static const std::string & CStationType::sANTENNA_PAD [static]

Enumerators as strings.

A const string equal to "ANTENNA_PAD".

Definition at line 92 of file CStationType.h.

static const std::string & CStationType::sMAINTENANCE_PAD [static]

A const string equal to "MAINTENANCE_PAD".

Definition at line 94 of file CStationType.h.

static const std::string & CStationType::sWEATHER_STATION [static]

A const string equal to "WEATHER_STATION".

Definition at line 96 of file CStationType.h.

---

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

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