Teuchos_StringToIntMap.cpp

// @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

#include "Teuchos_StringToIntMap.hpp"

namespace Teuchos {

StringToIntMap::StringToIntMap(
  const std::string& defaultGroupName_in, int n, const char* strings[]
  ) : defaultGroupName_(defaultGroupName_in)
{
  typedef map_t::value_type val_t;
  for( int i = 0; i < n; ++i ) {
    const bool unique = map_.insert( val_t( strings[i], i ) ).second;
    TEUCHOS_TEST_FOR_EXCEPTION(
      !unique, AlreadyExists
      ,"Teuchos::StringToIntMap::StringToIntMap(...): "
      << "Error, the std::string \"" << strings[i] << "\" is a duplicate for "
      << defaultGroupName_ );
  }
}

int StringToIntMap::get( const std::string& option, const std::string& groupName ) const
{
  map_t::const_iterator itr = map_.find( option );
  TEUCHOS_TEST_FOR_EXCEPTION(
    itr == map_.end(), DoesNotExist
    ,"Teuchos::StringToIntMap:::get(\""<<option<<"\",...): "
    << "Error, the std::string \"" << option << "\" is not recongnised for "
    << ( groupName.length() ? groupName : defaultGroupName_ )
    << "; valid selections include " << this->validSelections() << "."
    );
  return (*itr).second; 
}

// private

std::string StringToIntMap::validSelections() const
{
  std::ostringstream oss;
  oss << "{";
  map_t::const_iterator itr = map_.begin();
  for( int i = 0; itr != map_.end(); ++itr, ++i ) {
    if(i > 0)
      oss << ",";
    oss << "\""<<itr->first<<"\":"<<itr->second;
  }
  oss << "}";
  return oss.str();
}

} // end namespace Teuchos