Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Related Functions | List of all members
Teuchos::StringToIntMap Class Reference

Map a std::string to an enumeration. More...

#include <Teuchos_StringToIntMap.hpp>

Classes

class  AlreadyExists
 
class  DoesNotExist
 

Public Member Functions

 StringToIntMap (const std::string &defaultGroupName, int n, const char *strings[])
 
int get (const std::string &option, const std::string &groupName="") const
 
template<class EnumType >
EnumType get (const std::string &option, const std::string &groupName="") const
 
const std::string & defaultGroupName () const
 

Related Functions

(Note that these are not member functions.)

template<class EnumType >
EnumType get (StringToIntMap const &theMap, std::string const &option, std::string const &groupName="")
 Nonmember get function. More...
 

Detailed Description

Map a std::string to an enumeration.

The purpose of this class is to simplify mapping a standard std::string to an integer which can be interpreted as an enumeration.

Here is an example of its use. 

 const int n_opt = 3;
 enum MyOptEnum {
   OPT_ONE
   ,OPT_TWO
   ,OPT_THREE
 };  // NOTE: Must be 0, 1,..., n_opt - 1
 const char* MyOptStrings[n_opt] = {
   "OPT_ONE
   ,"OPT_TWO"
   ,"OPT_THREE"
 }; // NOTE: parallels enums in MyOptEnum
 StringToIntMap my_enum_map( "opt_map", n_opt, NyOptStrings );
 ...
 switch( my_enum_map.get<MyOptEnum>("OPT_ONE") ) {
   case OPT_ONE:
     // do stuff
   case OPT_TWO:
     // do stuff
   case OPT_THREE:
     // do stuff
   default:
     // ???
 }

The number of strings passed to the constructor must equal the number of options in the enumeration. If there are duplicate strings (capitalization concidered) then the std::exception AlreadyExists is throw. If a std::string that was not passed in the constructor if given to operator()( const std::string& str ) then the std::exception DoesNotExist is thrown.

In the constructor, defaultGroupName is used in error messages in the exceptions thrown to help make since out of the message.

The default constructor is not defined and not to be called.

Definition at line 97 of file Teuchos_StringToIntMap.hpp.

Constructor & Destructor Documentation

Teuchos::StringToIntMap::StringToIntMap ( const std::string &  defaultGroupName,
int  n,
const char *  strings[] 
)

Definition at line 46 of file Teuchos_StringToIntMap.cpp.

Member Function Documentation

EnumType Teuchos::StringToIntMap::get ( const std::string &  option,
const std::string &  groupName = "" 
) const
inline

Definition at line 61 of file Teuchos_StringToIntMap.cpp.

template<class EnumType >
EnumType Teuchos::StringToIntMap::get ( const std::string &  option,
const std::string &  groupName = "" 
) const

const std::string & Teuchos::StringToIntMap::defaultGroupName ( ) const
inline

Definition at line 159 of file Teuchos_StringToIntMap.hpp.

Friends And Related Function Documentation

template<class EnumType >
EnumType get ( StringToIntMap const &  theMap,
std::string const &  option,
std::string const &  groupName = "" 
)
related

Nonmember get function.

Definition at line 139 of file Teuchos_StringToIntMap.hpp.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.5