CTimeScale Class Reference

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

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

Static Public Attributes
static const std::string &	sUTC
	Enumerators as strings. More...
static const std::string &	sTAI

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

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

Definition at line 83 of file CTimeScale.h.

Constructor & Destructor Documentation

CTimeScale::CTimeScale ( )

private

CTimeScale::CTimeScale ( const CTimeScale &  )

private

Member Function Documentation

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

staticprivate

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

staticprivate

static TimeScaleMod::TimeScale CTimeScale::from_int ( unsigned int  i )

static

Return a TimeScale's enumerator given an unsigned int.

Parameters

i	the index of the enumerator in TimeScaleMod::TimeScale.

Returns

a TimeScaleMod::TimeScale's enumerator.

Exceptions

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

static TimeScaleMod::TimeScale CTimeScale::literal ( const std::string &  name )

static

Return a TimeScale's enumerator given a string.

Parameters

name	the string representation of the enumerator.

Returns

a TimeScaleMod::TimeScale's enumerator.

Exceptions

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

static std::string CTimeScale::name ( const TimeScaleMod::TimeScale &  e )

static

Returns an enumerator as a string.

Parameters

e	an enumerator of TimeScaleMod::TimeScale.

Returns

a string.

static const std::vector<std::string> CTimeScale::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 TimeScaleMod::TimeScale CTimeScale::newTimeScale ( const std::string &  name )

static

Create a TimeScale enumeration object by specifying its name.

CTimeScale& CTimeScale::operator= ( const CTimeScale &  )

private

static std::string CTimeScale::revision ( )

static

Return the revision as a string.

Returns

a string

static unsigned int CTimeScale::size ( )

static

Return the number of enumerators declared in TimeScaleMod::TimeScale.

Returns

an unsigned int.

static std::string CTimeScale::toString ( const TimeScaleMod::TimeScale &  f )

inlinestatic

Equivalent to the name method.

Definition at line 127 of file CTimeScale.h.

static int CTimeScale::version ( )

static

Return the major version number as an int.

Returns

an int.

Member Data Documentation

const std::string& CTimeScale::sTAI

static

A const string equal to "TAI".

Definition at line 92 of file CTimeScale.h.

const std::string& CTimeScale::sUTC

static

Enumerators as strings.

A const string equal to "UTC".

Definition at line 90 of file CTimeScale.h.

---

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

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