Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_StringToIntMap.hpp
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef TEUCHOS_STRING_TO_INT_MAP_HPP
43#define TEUCHOS_STRING_TO_INT_MAP_HPP
44
45#include "Teuchos_Assert.hpp"
46#include <map>
47#include <string>
48
49namespace Teuchos {
50
98public:
99
101 class AlreadyExists : public std::logic_error
102 {public: AlreadyExists(const std::string& what_arg) : std::logic_error(what_arg) {}};
103
105 class DoesNotExist : public std::logic_error
106 {public: DoesNotExist(const std::string& what_arg) : std::logic_error(what_arg) {}};
107
109 StringToIntMap( const std::string& defaultGroupName, int n, const char* strings[] );
110
112 int get( const std::string& option, const std::string& groupName = "" ) const;
113
115 template<class EnumType>
116 EnumType get( const std::string& option, const std::string& groupName = "" ) const;
117
119 const std::string& defaultGroupName() const;
120
121private:
122
123 typedef std::map< std::string, int > map_t; // all share implementation.
124 std::string defaultGroupName_;
125 map_t map_;
126
127 std::string validSelections() const;
128
129 // not defined and not to be called.
131
132}; // end class StringToIntMap
133
137template<class EnumType>
138inline
139EnumType get(
140 StringToIntMap const& theMap
141 ,std::string const& option
142 ,std::string const& groupName = ""
143 )
144{
145 return static_cast<EnumType>(theMap.get(option,groupName));
146}
147
148// ////////////////////////////////////////////
149// Inline declarations
150
151template<class EnumType>
152inline
153EnumType StringToIntMap::get( const std::string& option, const std::string& groupName ) const
154{
155 return static_cast<EnumType>(get(option,groupName));
156}
157
158inline
159const std::string& StringToIntMap::defaultGroupName() const
160{
161 return defaultGroupName_;
162}
163
164} // end namespace Teuchos
165
166#endif // TEUCHOS_STRING_TO_INT_MAP_HPP
Map a std::string to an enumeration.
EnumType get(StringToIntMap const &theMap, std::string const &option, std::string const &groupName="")
Nonmember get function.
int get(const std::string &option, const std::string &groupName="") const
const std::string & defaultGroupName() const
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...