src/OpenFOAM/containers/HashTables/Map/Map.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::Map
  27
  28 Description
  29     A HashTable to objects of type \<T\> with a label key.
  30
  31 See Also
  32     PtrMap
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef Map_H
  37 #define Map_H
  38
  39 #include <OpenFOAM/HashTable.H>
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class Map Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class T>
  51 class Map
  52 :
  53     public HashTable<T, label, Hash<label> >
  54 {
  55
  56 public:
  57
  58     typedef typename HashTable<T, label, Hash<label> >::iterator iterator;
  59
  60     typedef typename HashTable<T, label, Hash<label> >::const_iterator
  61         const_iterator;
  62
  63     // Constructors
  64
  65         //- Construct given initial size
  66         Map(const label size = 128)
  67         :
  68             HashTable<T, label, Hash<label> >(size)
  69         {}
  70
  71         //- Construct from Istream
  72         Map(Istream& is)
  73         :
  74             HashTable<T, label, Hash<label> >(is)
  75         {}
  76
  77         //- Construct as copy
  78         Map(const Map<T>& map)
  79         :
  80             HashTable<T, label, Hash<label> >(map)
  81         {}
  82
  83         //- Construct by transferring the parameter contents
  84         Map(const Xfer<Map<T> >& map)
  85         :
  86             HashTable<T, label, Hash<label> >(map)
  87         {}
  88
  89         //- Construct by transferring the parameter contents
  90         Map(const Xfer<HashTable<T, label, Hash<label> > >& map)
  91         :
  92             HashTable<T, label, Hash<label> >(map)
  93         {}
  94
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace Foam
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 #endif
 105
 106 // ************************ vim: set sw=4 sts=4 et: ************************ //