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

#include <CStokesParameter.h>

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 StokesParameterMod::StokesParameter.
static std::string	name (const StokesParameterMod::StokesParameter &e)
	Returns an enumerator as a string.
static std::string	toString (const StokesParameterMod::StokesParameter &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static StokesParameterMod::StokesParameter	newStokesParameter (const std::string &name)
	Create a StokesParameter enumeration object by specifying its name.
static StokesParameterMod::StokesParameter	literal (const std::string &name)
static StokesParameterMod::StokesParameter	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 StokesParameterMod::StokesParameter.
static std::string	name (const StokesParameterMod::StokesParameter &e)
	Returns an enumerator as a string.
static std::string	toString (const StokesParameterMod::StokesParameter &f)
	Equivalent to the name method.
static const std::vector < std::string >	names ()
	Returns vector of all the enumerators as strings.
static StokesParameterMod::StokesParameter	newStokesParameter (const std::string &name)
	Create a StokesParameter enumeration object by specifying its name.
static StokesParameterMod::StokesParameter	literal (const std::string &name)
static StokesParameterMod::StokesParameter	from_int (unsigned int i)
Static Public Attributes
static const std::string &	sI
	Enumerators as strings.
static const std::string &	sQ
static const std::string &	sU
static const std::string &	sV
static const std::string &	sRR
static const std::string &	sRL
static const std::string &	sLR
static const std::string &	sLL
static const std::string &	sXX
static const std::string &	sXY
static const std::string &	sYX
static const std::string &	sYY
static const std::string &	sRX
static const std::string &	sRY
static const std::string &	sLX
static const std::string &	sLY
static const std::string &	sXR
static const std::string &	sXL
static const std::string &	sYR
static const std::string &	sYL
static const std::string &	sPP
static const std::string &	sPQ
static const std::string &	sQP
static const std::string &	sQQ
static const std::string &	sRCIRCULAR
static const std::string &	sLCIRCULAR
static const std::string &	sLINEAR
static const std::string &	sPTOTAL
static const std::string &	sPLINEAR
static const std::string &	sPFTOTAL
static const std::string &	sPFLINEAR
static const std::string &	sPANGLE
Private Member Functions
	CStokesParameter ()
	CStokesParameter (const CStokesParameter &)
CStokesParameter &	operator= (const CStokesParameter &)
	CStokesParameter ()
	CStokesParameter (const CStokesParameter &)
CStokesParameter &	operator= (const CStokesParameter &)
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 StokesParameter.

Definition at line 143 of file CStokesParameter.h.

Constructor & Destructor Documentation

CStokesParameter::CStokesParameter ( ) [private]

CStokesParameter::CStokesParameter ( const CStokesParameter & ) [private]

CStokesParameter::CStokesParameter ( ) [private]

CStokesParameter::CStokesParameter ( const CStokesParameter & ) [private]

Member Function Documentation

static std::string CStokesParameter::badInt ( unsigned int i ) [static, private]

static std::string CStokesParameter::badString ( const std::string & name ) [static, private]

static StokesParameterMod::StokesParameter CStokesParameter::from_int ( unsigned int i ) [static]

Return a StokesParameter's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in StokesParameterMod::StokesParameter.

Returns:: a StokesParameterMod::StokesParameter's enumerator.

Exceptions:

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

static StokesParameterMod::StokesParameter CStokesParameter::from_int ( unsigned int i ) [static]

Return a StokesParameter's enumerator given an unsigned int.

Parameters:

i	the index of the enumerator in StokesParameterMod::StokesParameter.

Returns:: a StokesParameterMod::StokesParameter's enumerator.

Exceptions:

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

static StokesParameterMod::StokesParameter CStokesParameter::literal ( const std::string & name ) [static]

Return a StokesParameter's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:: a StokesParameterMod::StokesParameter's enumerator.

Exceptions:

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

static StokesParameterMod::StokesParameter CStokesParameter::literal ( const std::string & name ) [static]

Return a StokesParameter's enumerator given a string.

Parameters:

name	the string representation of the enumerator.

Returns:: a StokesParameterMod::StokesParameter's enumerator.

Exceptions:

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

static std::string CStokesParameter::name ( const StokesParameterMod::StokesParameter & e ) [static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of StokesParameterMod::StokesParameter.

Returns:: a string.

static std::string CStokesParameter::name ( const StokesParameterMod::StokesParameter & e ) [static]

Returns an enumerator as a string.

Parameters:

e	an enumerator of StokesParameterMod::StokesParameter.

Returns:: a string.

static const std::vector<std::string> CStokesParameter::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> CStokesParameter::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 StokesParameterMod::StokesParameter CStokesParameter::newStokesParameter ( const std::string & name ) [static]

Create a StokesParameter enumeration object by specifying its name.

static StokesParameterMod::StokesParameter CStokesParameter::newStokesParameter ( const std::string & name ) [static]

Create a StokesParameter enumeration object by specifying its name.

CStokesParameter& CStokesParameter::operator= ( const CStokesParameter & ) [private]

static std::string CStokesParameter::revision ( ) [static]

Return the revision as a string.

Returns:: a string

static std::string CStokesParameter::revision ( ) [static]

Return the revision as a string.

Returns:: a string

static unsigned int CStokesParameter::size ( ) [static]

Return the number of enumerators declared in StokesParameterMod::StokesParameter.

Returns:: an unsigned int.

static unsigned int CStokesParameter::size ( ) [static]

Return the number of enumerators declared in StokesParameterMod::StokesParameter.

Returns:: an unsigned int.

static std::string CStokesParameter::toString ( const StokesParameterMod::StokesParameter & f ) [inline, static]

Equivalent to the name method.

Definition at line 247 of file CStokesParameter.h.

static std::string CStokesParameter::toString ( const StokesParameterMod::StokesParameter & f ) [inline, static]

Equivalent to the name method.

Definition at line 247 of file CStokesParameter.h.

static int CStokesParameter::version ( ) [static]

Return the major version number as an int.

Returns:: an int.

static int CStokesParameter::version ( ) [static]

Return the major version number as an int.

Returns:: an int.

Member Data Documentation

static const std::string & CStokesParameter::sI [static]

Enumerators as strings.

A const string equal to "I".

Definition at line 150 of file CStokesParameter.h.

static const std::string & CStokesParameter::sLCIRCULAR [static]

A const string equal to "LCIRCULAR".

Definition at line 200 of file CStokesParameter.h.

static const std::string & CStokesParameter::sLINEAR [static]

A const string equal to "LINEAR".

Definition at line 202 of file CStokesParameter.h.

static const std::string & CStokesParameter::sLL [static]

A const string equal to "LL".

Definition at line 164 of file CStokesParameter.h.

static const std::string & CStokesParameter::sLR [static]

A const string equal to "LR".

Definition at line 162 of file CStokesParameter.h.

static const std::string & CStokesParameter::sLX [static]

A const string equal to "LX".

Definition at line 178 of file CStokesParameter.h.

static const std::string & CStokesParameter::sLY [static]

A const string equal to "LY".

Definition at line 180 of file CStokesParameter.h.

static const std::string & CStokesParameter::sPANGLE [static]

A const string equal to "PANGLE".

Definition at line 212 of file CStokesParameter.h.

static const std::string & CStokesParameter::sPFLINEAR [static]

A const string equal to "PFLINEAR".

Definition at line 210 of file CStokesParameter.h.

static const std::string & CStokesParameter::sPFTOTAL [static]

A const string equal to "PFTOTAL".

Definition at line 208 of file CStokesParameter.h.

static const std::string & CStokesParameter::sPLINEAR [static]

A const string equal to "PLINEAR".

Definition at line 206 of file CStokesParameter.h.

static const std::string & CStokesParameter::sPP [static]

A const string equal to "PP".

Definition at line 190 of file CStokesParameter.h.

static const std::string & CStokesParameter::sPQ [static]

A const string equal to "PQ".

Definition at line 192 of file CStokesParameter.h.

static const std::string & CStokesParameter::sPTOTAL [static]

A const string equal to "PTOTAL".

Definition at line 204 of file CStokesParameter.h.

static const std::string & CStokesParameter::sQ [static]

A const string equal to "Q".

Definition at line 152 of file CStokesParameter.h.

static const std::string & CStokesParameter::sQP [static]

A const string equal to "QP".

Definition at line 194 of file CStokesParameter.h.

static const std::string & CStokesParameter::sQQ [static]

A const string equal to "QQ".

Definition at line 196 of file CStokesParameter.h.

static const std::string & CStokesParameter::sRCIRCULAR [static]

A const string equal to "RCIRCULAR".

Definition at line 198 of file CStokesParameter.h.

static const std::string & CStokesParameter::sRL [static]

A const string equal to "RL".

Definition at line 160 of file CStokesParameter.h.

static const std::string & CStokesParameter::sRR [static]

A const string equal to "RR".

Definition at line 158 of file CStokesParameter.h.

static const std::string & CStokesParameter::sRX [static]

A const string equal to "RX".

Definition at line 174 of file CStokesParameter.h.

static const std::string & CStokesParameter::sRY [static]

A const string equal to "RY".

Definition at line 176 of file CStokesParameter.h.

static const std::string & CStokesParameter::sU [static]

A const string equal to "U".

Definition at line 154 of file CStokesParameter.h.

static const std::string & CStokesParameter::sV [static]

A const string equal to "V".

Definition at line 156 of file CStokesParameter.h.

static const std::string & CStokesParameter::sXL [static]

A const string equal to "XL".

Definition at line 184 of file CStokesParameter.h.

static const std::string & CStokesParameter::sXR [static]

A const string equal to "XR".

Definition at line 182 of file CStokesParameter.h.

static const std::string & CStokesParameter::sXX [static]

A const string equal to "XX".

Definition at line 166 of file CStokesParameter.h.

static const std::string & CStokesParameter::sXY [static]

A const string equal to "XY".

Definition at line 168 of file CStokesParameter.h.

static const std::string & CStokesParameter::sYL [static]

A const string equal to "YL".

Definition at line 188 of file CStokesParameter.h.

static const std::string & CStokesParameter::sYR [static]

A const string equal to "YR".

Definition at line 186 of file CStokesParameter.h.

static const std::string & CStokesParameter::sYX [static]

A const string equal to "YX".

Definition at line 170 of file CStokesParameter.h.

static const std::string & CStokesParameter::sYY [static]

A const string equal to "YY".

Definition at line 172 of file CStokesParameter.h.

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

code/alma/Enumerations/CStokesParameter.h
code/alma_v3/Enumerations/CStokesParameter.h

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation