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
CTimeSampling Class Reference

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

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

Static Public Attributes

static const std::string & sSUBINTEGRATION
 Enumerators as strings. More...
 
static const std::string & sINTEGRATION
 

Private Member Functions

 CTimeSampling ()
 
 CTimeSampling (const CTimeSampling &)
 
CTimeSamplingoperator= (const CTimeSampling &)
 

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

Definition at line 83 of file CTimeSampling.h.

Constructor & Destructor Documentation

CTimeSampling::CTimeSampling ( )
private
CTimeSampling::CTimeSampling ( const CTimeSampling )
private

Member Function Documentation

static std::string CTimeSampling::badInt ( unsigned int  i)
staticprivate
static std::string CTimeSampling::badString ( const std::string &  name)
staticprivate
static TimeSamplingMod::TimeSampling CTimeSampling::from_int ( unsigned int  i)
static

Return a TimeSampling's enumerator given an unsigned int.

Parameters
ithe index of the enumerator in TimeSamplingMod::TimeSampling.
Returns
a TimeSamplingMod::TimeSampling's enumerator.
Exceptions
astring containing an error message if no enumerator could be found for this integer.
static TimeSamplingMod::TimeSampling CTimeSampling::literal ( const std::string &  name)
static

Return a TimeSampling's enumerator given a string.

Parameters
namethe string representation of the enumerator.
Returns
a TimeSamplingMod::TimeSampling's enumerator.
Exceptions
astring containing an error message if no enumerator could be found for this name.
static std::string CTimeSampling::name ( const TimeSamplingMod::TimeSampling &  e)
static

Returns an enumerator as a string.

Parameters
ean enumerator of TimeSamplingMod::TimeSampling.
Returns
a string.
static const std::vector<std::string> CTimeSampling::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 TimeSamplingMod::TimeSampling CTimeSampling::newTimeSampling ( const std::string &  name)
static

Create a TimeSampling enumeration object by specifying its name.

CTimeSampling& CTimeSampling::operator= ( const CTimeSampling )
private
static std::string CTimeSampling::revision ( )
static

Return the revision as a string.

Returns
a string
static unsigned int CTimeSampling::size ( )
static

Return the number of enumerators declared in TimeSamplingMod::TimeSampling.

Returns
an unsigned int.
static std::string CTimeSampling::toString ( const TimeSamplingMod::TimeSampling &  f)
inlinestatic

Equivalent to the name method.

Definition at line 127 of file CTimeSampling.h.

static int CTimeSampling::version ( )
static

Return the major version number as an int.

Returns
an int.

Member Data Documentation

const std::string& CTimeSampling::sINTEGRATION
static

A const string equal to "INTEGRATION".

Definition at line 92 of file CTimeSampling.h.

const std::string& CTimeSampling::sSUBINTEGRATION
static

Enumerators as strings.

A const string equal to "SUBINTEGRATION".

Definition at line 90 of file CTimeSampling.h.


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