Dictionary.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-2013 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::Dictionary
26 
27 Description
28  Gerneral purpose template dictionary class which manages the storage
29  associated with it.
30 
31  It is derived from DictionaryBase instantiated on a memory managed form
32  of intrusive doubly-linked list of <T>.
33 
34 SourceFiles
35  Dictionary.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef Dictionary_H
40 #define Dictionary_H
41 
42 #include "DictionaryBase.H"
43 #include "IDLList.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class Dictionary Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class T>
55 class Dictionary
56 :
57  public DictionaryBase<IDLList<T>, T>
58 {
59 
60 public:
61 
62  // Constructors
63 
64  //- Construct given initial table size
65  Dictionary(const label size = 128);
66 
67  //- Copy construct
68  Dictionary(const Dictionary&);
69 
70 
71  // Member functions
72 
73  //- Remove an entry specified by keyword and delete the pointer.
74  // Returns true if the keyword was found
75  bool erase(const word& keyword);
76 };
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace Foam
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #ifdef NoRepository
86 # include "Dictionary.C"
87 #endif
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 #endif
92 
93 // ************************************************************************* //
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
bool erase(const word &keyword)
Remove an entry specified by keyword and delete the pointer.
Definition: Dictionary.C:47
label size() const
Return number of elements in list.
Definition: DLListBaseI.H:77
Namespace for OpenFOAM.
Gerneral purpose template dictionary class which manages the storage associated with it...
Definition: Dictionary.H:54
Dictionary(const label size=128)
Construct given initial table size.
Definition: Dictionary.C:31
Base dictionary class templated on both the form of doubly-linked list it uses as well as the type it...