Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_StringToIntMap.hpp
Go to the documentation of this file.
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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_STRING_TO_INT_MAP_HPP
00043 #define TEUCHOS_STRING_TO_INT_MAP_HPP
00044 
00045 #include "Teuchos_TestForException.hpp"
00046 
00047 namespace Teuchos {
00048 
00095 class StringToIntMap {
00096 public:
00097 
00099   class AlreadyExists : public std::logic_error
00100   {public: AlreadyExists(const std::string& what_arg) : std::logic_error(what_arg) {}};
00101 
00103   class DoesNotExist : public std::logic_error
00104   {public: DoesNotExist(const std::string& what_arg) : std::logic_error(what_arg) {}};
00105 
00107   StringToIntMap( const std::string& defaultGroupName, int n, const char* strings[] );
00108 
00110   int get( const std::string& option, const std::string& groupName = "" ) const;
00111 
00113   template<class EnumType>
00114   EnumType get( const std::string& option, const std::string& groupName = "" ) const;
00115 
00117   const std::string& defaultGroupName() const;
00118 
00119 private:
00120 
00121   typedef std::map< std::string, int > map_t;  // all share implementation.
00122   std::string defaultGroupName_;
00123   map_t map_;
00124 
00125   std::string validSelections() const;
00126 
00127   // not defined and not to be called.
00128   StringToIntMap();
00129 
00130 };  // end class StringToIntMap
00131 
00135 template<class EnumType>
00136 inline
00137 EnumType get(
00138   StringToIntMap const& theMap
00139   ,std::string const& option
00140   ,std::string const& groupName = ""
00141   )
00142 {
00143   return static_cast<EnumType>(theMap.get(option,groupName));
00144 }
00145 
00146 // ////////////////////////////////////////////
00147 // Inline declarations
00148 
00149 template<class EnumType>
00150 inline
00151 EnumType StringToIntMap::get( const std::string& option, const std::string& groupName ) const
00152 {
00153   return static_cast<EnumType>(get(option,groupName));
00154 }
00155 
00156 inline
00157 const std::string& StringToIntMap::defaultGroupName() const
00158 {
00159   return defaultGroupName_;
00160 }
00161 
00162 }  // end namespace Teuchos
00163 
00164 #endif  // TEUCHOS_STRING_TO_INT_MAP_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines