FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

PtrMap.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::PtrMap
00026 
00027 Description
00028     A HashTable of pointers to objects of type <T> with a label key.
00029 
00030 See Also
00031     Map, HashPtrTable
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef PtrMap_H
00036 #define PtrMap_H
00037 
00038 #include <OpenFOAM/HashPtrTable.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class PtrMap Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class T>
00050 class PtrMap
00051 :
00052     public HashPtrTable<T, label, Hash<label> >
00053 {
00054 
00055 public:
00056 
00057     // Constructors
00058 
00059         //- Construct given initial map size
00060         PtrMap(const label size = 128)
00061         :
00062             HashPtrTable<T, label, Hash<label> >(size)
00063         {}
00064 
00065         //- Construct from Istream
00066         PtrMap(Istream& is)
00067         :
00068             HashPtrTable<T, label, Hash<label> >(is)
00069         {}
00070 
00071         //- Construct as copy
00072         PtrMap(const PtrMap<T>& map)
00073         :
00074             HashPtrTable<T, label, Hash<label> >(map)
00075         {}
00076 };
00077 
00078 
00079 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00080 
00081 } // End namespace Foam
00082 
00083 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00084 
00085 #endif
00086 
00087 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines