casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Static Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Member Functions
CCorrelationBit Class Reference

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

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

Static Public Attributes

static const std::string & sBITS_2x2
 Enumerators as strings.
static const std::string & sBITS_3x3
static const std::string & sBITS_4x4

Private Member Functions

 CCorrelationBit ()
 CCorrelationBit (const CCorrelationBit &)
CCorrelationBitoperator= (const CCorrelationBit &)
 CCorrelationBit ()
 CCorrelationBit (const CCorrelationBit &)
CCorrelationBitoperator= (const CCorrelationBit &)

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

Definition at line 85 of file CCorrelationBit.h.


Constructor & Destructor Documentation


Member Function Documentation

static std::string CCorrelationBit::badInt ( unsigned int  i) [static, private]
static std::string CCorrelationBit::badInt ( unsigned int  i) [static, private]
static std::string CCorrelationBit::badString ( const std::string &  name) [static, private]
static std::string CCorrelationBit::badString ( const std::string &  name) [static, private]
static CorrelationBitMod::CorrelationBit CCorrelationBit::from_int ( unsigned int  i) [static]

Return a CorrelationBit's enumerator given an unsigned int.

Parameters:
ithe index of the enumerator in CorrelationBitMod::CorrelationBit.
Returns:
a CorrelationBitMod::CorrelationBit's enumerator.
Exceptions:
astring containing an error message if no enumerator could be found for this integer.
static CorrelationBitMod::CorrelationBit CCorrelationBit::from_int ( unsigned int  i) [static]

Return a CorrelationBit's enumerator given an unsigned int.

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

Return a CorrelationBit's enumerator given a string.

Parameters:
namethe string representation of the enumerator.
Returns:
a CorrelationBitMod::CorrelationBit's enumerator.
Exceptions:
astring containing an error message if no enumerator could be found for this name.
static CorrelationBitMod::CorrelationBit CCorrelationBit::literal ( const std::string &  name) [static]

Return a CorrelationBit's enumerator given a string.

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

Returns an enumerator as a string.

Parameters:
ean enumerator of CorrelationBitMod::CorrelationBit.
Returns:
a string.
static std::string CCorrelationBit::name ( const CorrelationBitMod::CorrelationBit &  e) [static]

Returns an enumerator as a string.

Parameters:
ean enumerator of CorrelationBitMod::CorrelationBit.
Returns:
a string.
static const std::vector<std::string> CCorrelationBit::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> CCorrelationBit::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 CorrelationBitMod::CorrelationBit CCorrelationBit::newCorrelationBit ( const std::string &  name) [static]

Create a CorrelationBit enumeration object by specifying its name.

static CorrelationBitMod::CorrelationBit CCorrelationBit::newCorrelationBit ( const std::string &  name) [static]

Create a CorrelationBit enumeration object by specifying its name.

CCorrelationBit& CCorrelationBit::operator= ( const CCorrelationBit ) [private]
CCorrelationBit& CCorrelationBit::operator= ( const CCorrelationBit ) [private]
static std::string CCorrelationBit::revision ( ) [static]

Return the revision as a string.

Returns:
a string
static std::string CCorrelationBit::revision ( ) [static]

Return the revision as a string.

Returns:
a string
static unsigned int CCorrelationBit::size ( ) [static]

Return the number of enumerators declared in CorrelationBitMod::CorrelationBit.

Returns:
an unsigned int.
static unsigned int CCorrelationBit::size ( ) [static]

Return the number of enumerators declared in CorrelationBitMod::CorrelationBit.

Returns:
an unsigned int.
static std::string CCorrelationBit::toString ( const CorrelationBitMod::CorrelationBit &  f) [inline, static]

Equivalent to the name method.

Definition at line 131 of file CCorrelationBit.h.

static std::string CCorrelationBit::toString ( const CorrelationBitMod::CorrelationBit &  f) [inline, static]

Equivalent to the name method.

Definition at line 131 of file CCorrelationBit.h.

static int CCorrelationBit::version ( ) [static]

Return the major version number as an int.

Returns:
an int.
static int CCorrelationBit::version ( ) [static]

Return the major version number as an int.

Returns:
an int.

Member Data Documentation

static const std::string & CCorrelationBit::sBITS_2x2 [static]

Enumerators as strings.

A const string equal to "BITS_2x2".

Definition at line 92 of file CCorrelationBit.h.

static const std::string & CCorrelationBit::sBITS_3x3 [static]

A const string equal to "BITS_3x3".

Definition at line 94 of file CCorrelationBit.h.

static const std::string & CCorrelationBit::sBITS_4x4 [static]

A const string equal to "BITS_4x4".

Definition at line 96 of file CCorrelationBit.h.


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