PtrListDictionary.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2015-2020 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::PtrListDictionary
26 
27 Description
28  Template dictionary class which manages the storage associated with it.
29 
30  It is derived from DictionaryBase instantiated on the memory managed PtrList
31  of <T> to provide ordered indexing in addition to the dictionary lookup.
32 
33 SourceFiles
34  PtrListDictionary.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef PtrListDictionary_H
39 #define PtrListDictionary_H
40 
41 #include "DictionaryBase.H"
42 #include "PtrList.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class PtrListDictionary Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class T>
55 :
56  public DictionaryBase<PtrList<T>, T>
57 {
58 
59 public:
60 
61  // Constructors
62 
63  //- Construct given initial list size
65 
66  //- Copy constructor
68 
69  //- Move constructor
71 
72  //- Construct from Istream using given Istream constructor class
73  template<class INew>
74  PtrListDictionary(Istream&, const INew&);
75 
76  //- Construct from Istream
78 
79 
80  // Member Functions
81 
82  //- Set element to pointer provided and return old element
83  autoPtr<T> set(const label, const word& key, T*);
84 
85  //- Set element to autoPtr value provided and return old element
86  autoPtr<T> set(const label, const word& key, autoPtr<T>&);
87 
88  //- Set element to tmp value provided and return old element
89  autoPtr<T> set(const label, const word& key, tmp<T>&);
90 
91 
92  // Member Operators
93 
94  using PtrList<T>::operator[];
95 
96  //- Find and return entry
97  const T& operator[](const word& key) const
98  {
99  return *DictionaryBase<PtrList<T>, T>::operator[](key);
100  }
101 
102  //- Find and return entry
103  T& operator[](const word& key)
104  {
105  return *DictionaryBase<PtrList<T>, T>::operator[](key);
106  }
107 };
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #ifdef NoRepository
117  #include "PtrListDictionary.C"
118 #endif
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #endif
123 
124 // ************************************************************************* //
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
PtrListDictionary(const label size)
Construct given initial list size.
Base dictionary class templated on both the form of doubly-linked list it uses as well as the type it...
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
friend Ostream & operator(Ostream &, const DictionaryBase< PtrList< T >, T > &)
Template dictionary class which manages the storage associated with it.
A class for handling words, derived from string.
Definition: word.H:59
const T & operator[](const word &key) const
Find and return entry.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
label size() const
Return the number of elements in the UPtrList.
Definition: UPtrListI.H:29
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:70
A helper class when constructing from an Istream or dictionary.
Definition: INew.H:49
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.