OptionsFromStreamPack::StringToIntMap Class Reference

Map a string to an enumeration. More...

#include <OptionsFromStreamPack_StringToIntMap.hpp>

Classes
class	AlreadyExists
class	DoesNotExist

Public Member Functions
	StringToIntMap (const std::string &name, int n, const char *strings[])
int	operator() (const std::string &str) const
const std::string &	name () const

Detailed Description

Map a string to an enumeration.

The purpose of this class is to simplify mapping a standard 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
};  // must be 0, 1,..., n_opt - 1
const char* MyOptStrings[n_opt] = {
  "OPT_ONE
  ,"OPT_TWO"
  ,"OPT_THREE"
}; // parallels MyOptEnum
StringToIntMap my_enum_map( "opt_map", n_opt, NyOptStrings );
...
switch( (MyEnum)my_enum_map( "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 exception #AlreadyExists# is throw. If a string that was not passed in the constructor if given to #operator()( const std::string& str )# then the exception #DoesNotExist# is thrown.

In the constructor, name# 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 96 of file OptionsFromStreamPack_StringToIntMap.hpp.

Constructor & Destructor Documentation

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

Definition at line 46 of file OptionsFromStreamPack_StringToIntMap.cpp.

Member Function Documentation

int OptionsFromStreamPack::StringToIntMap::operator()

(

const std::string &

str

)

const

Definition at line 60 of file OptionsFromStreamPack_StringToIntMap.cpp.

const std::string & OptionsFromStreamPack::StringToIntMap::name ( ) const

inline

Definition at line 130 of file OptionsFromStreamPack_StringToIntMap.hpp.

---

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

• OptionsFromStreamPack_StringToIntMap.hpp
• OptionsFromStreamPack_StringToIntMap.cpp