simgear/structure/map.hxx

   1 ///@file Extended std::map with methods for easier usage.
   2 //
   3 // Copyright (C) 2013  Thomas Geymayer <tomgey@gmail.com>
   4 //
   5 // This library is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU Library General Public
   7 // License as published by the Free Software Foundation; either
   8 // version 2 of the License, or (at your option) any later version.
   9 //
  10 // This library is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // Library General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU Library General Public
  16 // License along with this library; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  18
  19 #ifndef SG_MAP_HXX_
  20 #define SG_MAP_HXX_
  21
  22 #include <map>
  23 #include <string>
  24
  25 namespace simgear
  26 {
  27
  28   template<class Key, class Value>
  29   class Map:
  30     public std::map<Key, Value>
  31   {
  32     public:
  33       Map() {}
  34
  35       /**
  36        * Initilize a new mape with the given key/value pair.
  37        */
  38       Map(const Key& key, const Value& value)
  39       {
  40         (*this)[key] = value;
  41       }
  42
  43       /**
  44        * Change/add new value.
  45        */
  46       Map& operator()(const Key& key, const Value& value)
  47       {
  48         (*this)[key] = value;
  49         return *this;
  50       }
  51
  52       /**
  53        * Retrive a value (or get a default value if it does not exist).
  54        */
  55       Value get(const Key& key, const Value& def = Value()) const
  56       {
  57         typename Map::const_iterator it = this->find(key);
  58         if( it != this->end() )
  59           return it->second;
  60
  61         return def;
  62       }
  63   };
  64
  65   typedef Map<std::string, std::string> StringMap;
  66
  67 } // namespace simgear
  68
  69 #endif /* SG_MAP_HXX_ */