src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.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::PtrMap
  27
  28 Description
  29     A HashTable of pointers to objects of type \<T\> with a label key.
  30
  31 See Also
  32     Map, HashPtrTable
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef PtrMap_H
  37 #define PtrMap_H
  38
  39 #include "HashPtrTable.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class PtrMap Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class T>
  51 class PtrMap
  52 :
  53     public HashPtrTable<T, label, Hash<label> >
  54 {
  55
  56 public:
  57
  58     // Constructors
  59
  60         //- Construct given initial map size
  61         PtrMap(const label size = 128)
  62         :
  63             HashPtrTable<T, label, Hash<label> >(size)
  64         {}
  65
  66         //- Construct from Istream
  67         PtrMap(Istream& is)
  68         :
  69             HashPtrTable<T, label, Hash<label> >(is)
  70         {}
  71
  72         //- Construct as copy
  73         PtrMap(const PtrMap<T>& map)
  74         :
  75             HashPtrTable<T, label, Hash<label> >(map)
  76         {}
  77 };
  78
  79
  80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  81
  82 } // End namespace Foam
  83
  84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  85
  86 #endif
  87
  88 // ************************************************************************* //