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

Map.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::Map
00026 
00027 Description
00028     A HashTable to objects of type <T> with a label key.
00029 
00030 See Also
00031     PtrMap
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef Map_H
00036 #define Map_H
00037 
00038 #include <OpenFOAM/HashTable.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class Map Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class T>
00050 class Map
00051 :
00052     public HashTable<T, label, Hash<label> >
00053 {
00054 
00055 public:
00056 
00057     typedef typename HashTable<T, label, Hash<label> >::iterator iterator;
00058 
00059     typedef typename HashTable<T, label, Hash<label> >::const_iterator
00060         const_iterator;
00061 
00062     // Constructors
00063 
00064         //- Construct given initial size
00065         Map(const label size = 128)
00066         :
00067             HashTable<T, label, Hash<label> >(size)
00068         {}
00069 
00070         //- Construct from Istream
00071         Map(Istream& is)
00072         :
00073             HashTable<T, label, Hash<label> >(is)
00074         {}
00075 
00076         //- Construct as copy
00077         Map(const Map<T>& map)
00078         :
00079             HashTable<T, label, Hash<label> >(map)
00080         {}
00081 
00082         //- Construct by transferring the parameter contents
00083         Map(const Xfer<Map<T> >& map)
00084         :
00085             HashTable<T, label, Hash<label> >(map)
00086         {}
00087 
00088         //- Construct by transferring the parameter contents
00089         Map(const Xfer<HashTable<T, label, Hash<label> > >& map)
00090         :
00091             HashTable<T, label, Hash<label> >(map)
00092         {}
00093 
00094 };
00095 
00096 
00097 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00098 
00099 } // End namespace Foam
00100 
00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00102 
00103 #endif
00104 
00105 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines