simgear/structure/map.hxx

   1 ///@file
   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   /**
  29    * Extended std::map with methods for easier usage.
  30    */
  31   template<class Key, class Value>
  32   class Map:
  33     public std::map<Key, Value>
  34   {
  35     public:
  36       Map() {}
  37
  38       /**
  39        * Initialize a new map with the given key/value pair.
  40        */
  41       Map(const Key& key, const Value& value)
  42       {
  43         (*this)[key] = value;
  44       }
  45
  46       /**
  47        * Change/add new value.
  48        */
  49       Map& operator()(const Key& key, const Value& value)
  50       {
  51         (*this)[key] = value;
  52         return *this;
  53       }
  54
  55       /**
  56        * Retrive a value (or get a default value if it does not exist).
  57        */
  58       Value get(const Key& key, const Value& def = Value()) const
  59       {
  60         typename Map::const_iterator it = this->find(key);
  61         if( it != this->end() )
  62           return it->second;
  63
  64         return def;
  65       }
  66   };
  67
  68   typedef Map<std::string, std::string> StringMap;
  69
  70 } // namespace simgear
  71
  72 #endif /* SG_MAP_HXX_ */