Teuchos_StringToIntMap.hpp

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_STRING_TO_INT_MAP_HPP
#define TEUCHOS_STRING_TO_INT_MAP_HPP

#include "Teuchos_Assert.hpp"
#include <map>
#include <string>

namespace Teuchos {

class StringToIntMap {
public:

  class AlreadyExists : public std::logic_error
  {public: AlreadyExists(const std::string& what_arg) : std::logic_error(what_arg) {}};

  class DoesNotExist : public std::logic_error
  {public: DoesNotExist(const std::string& what_arg) : std::logic_error(what_arg) {}};

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

  int get( const std::string& option, const std::string& groupName = "" ) const;

  template<class EnumType>
  EnumType get( const std::string& option, const std::string& groupName = "" ) const;

  const std::string& defaultGroupName() const;

private:

  typedef std::map< std::string, int > map_t;  // all share implementation.
  std::string defaultGroupName_;
  map_t map_;

  std::string validSelections() const;

  // not defined and not to be called.
  StringToIntMap();

};  // end class StringToIntMap

template<class EnumType>
inline
EnumType get(
  StringToIntMap const& theMap
  ,std::string const& option
  ,std::string const& groupName = ""
  )
{
  return static_cast<EnumType>(theMap.get(option,groupName));
}

// ////////////////////////////////////////////
// Inline declarations

template<class EnumType>
inline
EnumType StringToIntMap::get( const std::string& option, const std::string& groupName ) const
{
  return static_cast<EnumType>(get(option,groupName));
}

inline
const std::string& StringToIntMap::defaultGroupName() const
{
  return defaultGroupName_;
}

}  // end namespace Teuchos

#endif  // TEUCHOS_STRING_TO_INT_MAP_HPP