CSBType Class Reference
A helper class for the enumeration SBType.
More...
#include <CSBType.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 SBTypeMod::SBType.
|
| static std::string | name (const SBTypeMod::SBType &e) |
| | Returns an enumerator as a string.
|
| static std::string | toString (const SBTypeMod::SBType &f) |
| | Equivalent to the name method.
|
static const std::vector
< std::string > | names () |
| | Returns vector of all the enumerators as strings.
|
| static SBTypeMod::SBType | newSBType (const std::string &name) |
| | Create a SBType enumeration object by specifying its name.
|
| static SBTypeMod::SBType | literal (const std::string &name) |
| static SBTypeMod::SBType | from_int (unsigned int i) |
Static Public Attributes |
| static const std::string & | sOBSERVATORY |
| | Enumerators as strings.
|
| static const std::string & | sOBSERVER |
| static const std::string & | sEXPERT |
Private Member Functions |
| | CSBType () |
| | CSBType (const CSBType &) |
| CSBType & | operator= (const CSBType &) |
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 SBType.
Definition at line 85 of file CSBType.h.
Constructor & Destructor Documentation
| CSBType::CSBType |
( |
|
) |
[private] |
| CSBType::CSBType |
( |
const CSBType & |
|
) |
[private] |
Member Function Documentation
| static std::string CSBType::badInt |
( |
unsigned int |
i |
) |
[static, private] |
| static std::string CSBType::badString |
( |
const std::string & |
name |
) |
[static, private] |
| static SBTypeMod::SBType CSBType::from_int |
( |
unsigned int |
i |
) |
[static] |
Return a SBType's enumerator given an unsigned int.
- Parameters:
-
| i | the index of the enumerator in SBTypeMod::SBType. |
- Returns:
- a SBTypeMod::SBType's enumerator.
- Exceptions:
-
| a | string containing an error message if no enumerator could be found for this integer. |
| static SBTypeMod::SBType CSBType::literal |
( |
const std::string & |
name |
) |
[static] |
Return a SBType's enumerator given a string.
- Parameters:
-
| name | the string representation of the enumerator. |
- Returns:
- a SBTypeMod::SBType's enumerator.
- Exceptions:
-
| a | string containing an error message if no enumerator could be found for this name. |
| static std::string CSBType::name |
( |
const SBTypeMod::SBType & |
e |
) |
[static] |
Returns an enumerator as a string.
- Parameters:
-
| e | an enumerator of SBTypeMod::SBType. |
- Returns:
- a string.
| static const std::vector<std::string> CSBType::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 SBTypeMod::SBType CSBType::newSBType |
( |
const std::string & |
name |
) |
[static] |
Create a SBType enumeration object by specifying its name.
| static std::string CSBType::revision |
( |
|
) |
[static] |
Return the revision as a string.
- Returns:
- a string
| static unsigned int CSBType::size |
( |
|
) |
[static] |
Return the number of enumerators declared in SBTypeMod::SBType.
- Returns:
- an unsigned int.
| static std::string CSBType::toString |
( |
const SBTypeMod::SBType & |
f |
) |
[inline, static] |
Equivalent to the name method.
Definition at line 131 of file CSBType.h.
| static int CSBType::version |
( |
|
) |
[static] |
Return the major version number as an int.
- Returns:
- an int.
Member Data Documentation
A const string equal to "EXPERT".
Definition at line 96 of file CSBType.h.
Enumerators as strings.
A const string equal to "OBSERVATORY".
Definition at line 92 of file CSBType.h.
A const string equal to "OBSERVER".
Definition at line 94 of file CSBType.h.
The documentation for this class was generated from the following file: