OpenFOAM logo
Open Source CFD Toolkit

PtrDictionary.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-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     PtrDictionary
00027 
00028 Description
00029     Template dictionary class which does not manages the storage
00030     associated with it.  It is derived from DictionaryBase instantiated on
00031     a non-memory managed form of intrusive doubly-linked list of T.
00032 
00033 SourceFiles
00034     PtrDictionary.C
00035 
00036 \*---------------------------------------------------------------------------*/
00037 
00038 #ifndef PtrDictionary_H
00039 #define PtrDictionary_H
00040 
00041 #include "DictionaryBase.H"
00042 #include "DLPtrList.H"
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 /*---------------------------------------------------------------------------*\
00050                            Class PtrDictionary Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 template<class T>
00054 class PtrDictionary
00055 :
00056     public DictionaryBase<DLPtrList<T>, T>
00057 {
00058 
00059 public:
00060 
00061     // Constructors
00062 
00063         //- Null constructor
00064         PtrDictionary();
00065 
00066         //- Copy construct
00067         PtrDictionary(const PtrDictionary&);
00068 
00069         //- Construct from Istream using given Istream constructor class
00070         template<class INew>
00071         PtrDictionary(Istream&, const INew&);
00072 
00073         //- Construct from Istream
00074         PtrDictionary(Istream&);
00075 };
00076 
00077 
00078 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00079 
00080 } // End namespace Foam
00081 
00082 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00083 
00084 #ifdef NoRepository
00085 #   include "PtrDictionary.C"
00086 #endif
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 #endif
00091 
00092 // ************************************************************************* //
For further information go to www.openfoam.org