Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_StringToIntMap.cpp
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 #include "Teuchos_StringToIntMap.hpp"
43 
44 namespace Teuchos {
45 
46 StringToIntMap::StringToIntMap(
47  const std::string& defaultGroupName_in, int n, const char* strings[]
48  ) : defaultGroupName_(defaultGroupName_in)
49 {
50  typedef map_t::value_type val_t;
51  for( int i = 0; i < n; ++i ) {
52  const bool unique = map_.insert( val_t( strings[i], i ) ).second;
54  !unique, AlreadyExists
55  ,"Teuchos::StringToIntMap::StringToIntMap(...): "
56  << "Error, the std::string \"" << strings[i] << "\" is a duplicate for "
57  << defaultGroupName_ );
58  }
59 }
60 
61 int StringToIntMap::get( const std::string& option, const std::string& groupName ) const
62 {
63  map_t::const_iterator itr = map_.find( option );
65  itr == map_.end(), DoesNotExist
66  ,"Teuchos::StringToIntMap:::get(\""<<option<<"\",...): "
67  << "Error, the std::string \"" << option << "\" is not recongnised for "
68  << ( groupName.length() ? groupName : defaultGroupName_ )
69  << "; valid selections include " << this->validSelections() << "."
70  );
71  return (*itr).second;
72 }
73 
74 // private
75 
76 std::string StringToIntMap::validSelections() const
77 {
78  std::ostringstream oss;
79  oss << "{";
80  map_t::const_iterator itr = map_.begin();
81  for( int i = 0; itr != map_.end(); ++itr, ++i ) {
82  if(i > 0)
83  oss << ",";
84  oss << "\""<<itr->first<<"\":"<<itr->second;
85  }
86  oss << "}";
87  return oss.str();
88 }
89 
90 } // end namespace Teuchos
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
int get(const std::string &option, const std::string &groupName="") const