Teuchos_StringToIntMap.hpp

00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef TEUCHOS_STRING_TO_INT_MAP_HPP
00030 #define TEUCHOS_STRING_TO_INT_MAP_HPP
00031 
00032 #include "Teuchos_TestForException.hpp"
00033 
00034 namespace Teuchos {
00035 
00037 
00083 class StringToIntMap {
00084 public:
00085 
00087   class AlreadyExists : public std::logic_error
00088   {public: AlreadyExists(const std::string& what_arg) : std::logic_error(what_arg) {}};
00089 
00091   class DoesNotExist : public std::logic_error
00092   {public: DoesNotExist(const std::string& what_arg) : std::logic_error(what_arg) {}};
00093 
00095   StringToIntMap( const std::string& defaultGroupName, int n, const char* strings[] );
00096 
00098   int get( const std::string& option, const std::string& groupName = "" ) const;
00099 
00101   template<class EnumType>
00102   EnumType get( const std::string& option, const std::string& groupName = "" ) const;
00103 
00105   const std::string& defaultGroupName() const;
00106 
00107 private:
00108 
00109   typedef std::map< std::string, int > map_t; // all share implementation.
00110   std::string defaultGroupName_;
00111   map_t map_;
00112 
00113   std::string validSelections() const;
00114 
00115   // not defined and not to be called.
00116   StringToIntMap();
00117 
00118 };  // end class StringToIntMap
00119 
00120 // ////////////////////////////////////////////
00121 // Inline declarations
00122 
00123 template<class EnumType>
00124 inline
00125 EnumType StringToIntMap::get( const std::string& option, const std::string& groupName ) const
00126 {
00127   return static_cast<EnumType>(get(option,groupName));
00128 }
00129 
00130 inline
00131 const std::string& StringToIntMap::defaultGroupName() const
00132 {
00133   return defaultGroupName_;
00134 }
00135 
00136 } // end namespace Teuchos
00137 
00138 #endif  // TEUCHOS_STRING_TO_INT_MAP_HPP

Generated on Thu Sep 18 12:30:31 2008 for Teuchos - Trilinos Tools Package by doxygen 1.3.9.1