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) 2011-2015 OpenFOAM Foundation
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 manages the storage associated with it.
29 
30  It is derived from DictionaryBase instantiated on a memory managed form of
31  intrusive doubly-linked list of <T>.
32 
33 SourceFiles
34  PtrDictionary.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef PtrDictionary_H
39 #define PtrDictionary_H
40 
41 #include "DictionaryBase.H"
42 #include "DLPtrList.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class PtrDictionary Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class T>
54 class PtrDictionary
55 :
56  public DictionaryBase<DLPtrList<T>, T>
57 {
58 
59 public:
60 
61  // Constructors
62 
63  //- Construct given initial table size
64  PtrDictionary(const label size = 128);
65 
66  //- Copy construct
68 
69  //- Construct from Istream using given Istream constructor class
70  template<class INew>
71  PtrDictionary(Istream&, const INew&);
72 
73  //- Construct from Istream
75 
76 
77  // Member operators
78 
79  //- Find and return entry
80  const T& operator[](const word& key) const
81  {
83  }
84 
85  //- Find and return entry
86  T& operator[](const word& key)
87  {
89  }
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #ifdef NoRepository
100 # include "PtrDictionary.C"
101 #endif
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A class for handling words, derived from string.
Definition: word.H:59
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
friend Ostream & operator(Ostream &, const DictionaryBase< DLPtrList< T >, T > &)
A helper class when constructing from an Istream or dictionary.
Definition: INew.H:49
label size() const
Return number of elements in list.
Definition: DLListBaseI.H:77
Namespace for OpenFOAM.
const T & operator[](const word &key) const
Find and return entry.
Definition: PtrDictionary.H:79
Template dictionary class which manages the storage associated with it.
Definition: PtrDictionary.H:53
PtrDictionary(const label size=128)
Construct given initial table size.
Definition: PtrDictionary.C:31
Base dictionary class templated on both the form of doubly-linked list it uses as well as the type it...