Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
Teuchos_StringToIntMap.hpp
Go to the documentation of this file.
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 
47 namespace Teuchos {
48 
96 public:
97 
99  class AlreadyExists : public std::logic_error
100  {public: AlreadyExists(const std::string& what_arg) : std::logic_error(what_arg) {}};
101 
103  class DoesNotExist : public std::logic_error
104  {public: DoesNotExist(const std::string& what_arg) : std::logic_error(what_arg) {}};
105 
107  StringToIntMap( const std::string& defaultGroupName, int n, const char* strings[] );
108 
110  int get( const std::string& option, const std::string& groupName = "" ) const;
111 
113  template<class EnumType>
114  EnumType get( const std::string& option, const std::string& groupName = "" ) const;
115 
117  const std::string& defaultGroupName() const;
118 
119 private:
120 
121  typedef std::map< std::string, int > map_t; // all share implementation.
122  std::string defaultGroupName_;
124 
125  std::string validSelections() const;
126 
127  // not defined and not to be called.
128  StringToIntMap();
129 
130 }; // end class StringToIntMap
131 
135 template<class EnumType>
136 inline
137 EnumType get(
138  StringToIntMap const& theMap
139  ,std::string const& option
140  ,std::string const& groupName = ""
141  )
142 {
143  return static_cast<EnumType>(theMap.get(option,groupName));
144 }
145 
146 // ////////////////////////////////////////////
147 // Inline declarations
148 
149 template<class EnumType>
150 inline
151 EnumType StringToIntMap::get( const std::string& option, const std::string& groupName ) const
152 {
153  return static_cast<EnumType>(get(option,groupName));
154 }
155 
156 inline
157 const std::string& StringToIntMap::defaultGroupName() const
158 {
159  return defaultGroupName_;
160 }
161 
162 } // end namespace Teuchos
163 
164 #endif // TEUCHOS_STRING_TO_INT_MAP_HPP
int get(const std::string &option, const std::string &groupName="") const
std::string validSelections() const
Map a std::string to an enumeration.
const std::string & defaultGroupName() const
std::map< std::string, int > map_t