FreeFOAM The Cross-Platform CFD Toolkit
PtrMap.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::PtrMap
26 
27 Description
28  A HashTable of pointers to objects of type <T> with a label key.
29 
30 See Also
31  Map, HashPtrTable
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef PtrMap_H
36 #define PtrMap_H
37 
38 #include <OpenFOAM/HashPtrTable.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class PtrMap Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class T>
50 class PtrMap
51 :
52  public HashPtrTable<T, label, Hash<label> >
53 {
54 
55 public:
56 
57  // Constructors
58 
59  //- Construct given initial map size
60  PtrMap(const label size = 128)
61  :
62  HashPtrTable<T, label, Hash<label> >(size)
63  {}
64 
65  //- Construct from Istream
67  :
68  HashPtrTable<T, label, Hash<label> >(is)
69  {}
70 
71  //- Construct as copy
72  PtrMap(const PtrMap<T>& map)
73  :
74  HashPtrTable<T, label, Hash<label> >(map)
75  {}
76 };
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace Foam
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #endif
86 
87 // ************************ vim: set sw=4 sts=4 et: ************************ //