FreeFOAM The Cross-Platform CFD Toolkit
PtrDictionary.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::PtrDictionary
26 
27 Description
28  Template dictionary class which does not manages the storage
29  associated with it.
30 
31  It is derived from DictionaryBase instantiated on a non-memory managed
32  form of intrusive doubly-linked list of T.
33 
34 SourceFiles
35  PtrDictionary.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef PtrDictionary_H
40 #define PtrDictionary_H
41 
43 #include <OpenFOAM/DLPtrList.H>
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class PtrDictionary Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class T>
56 :
57  public DictionaryBase<DLPtrList<T>, T>
58 {
59 
60 public:
61 
62  // Constructors
63 
64  //- Null constructor
65  PtrDictionary();
66 
67  //- Copy construct
69 
70  //- Construct from Istream using given Istream constructor class
71  template<class INew>
72  PtrDictionary(Istream&, const INew&);
73 
74  //- Construct from Istream
76 };
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace Foam
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #ifdef NoRepository
86 # include <OpenFOAM/PtrDictionary.C>
87 #endif
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 #endif
92 
93 // ************************ vim: set sw=4 sts=4 et: ************************ //