File size: 5,564 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::DictionaryBase
Description
Base dictionary class templated on both the form of doubly-linked list
it uses as well as the type it holds.
The double templating allows for the instantiation of forms with or
without storage management.
Note:
The IDLListType parameter should itself be a template but this confused
gcc 2.95.2 so it has to be instantiated for T when an instantiation of
DictionaryBase is requested
See also
Dictionary and UDictionary
SourceFiles
DictionaryBase.C
DictionaryBaseIO.C
\*---------------------------------------------------------------------------*/
#ifndef DictionaryBase_H
#define DictionaryBase_H
#include "HashTable.H"
#include "wordList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
template<class IDLListType, class T>
class DictionaryBase;
template<class IDLListType, class T>
Ostream& operator<<(Ostream&, const DictionaryBase<IDLListType, T>&);
/*---------------------------------------------------------------------------*\
Class DictionaryBase Declaration
\*---------------------------------------------------------------------------*/
template<class IDLListType, class T>
class DictionaryBase
:
public IDLListType
{
protected:
// Protected data
//- HashTable of the entries held on the IDLListType for quick lookup
HashTable<T*> hashedTs_;
// Protected Member functions
// Add the IDLListType entries into the HashTable
void addEntries();
public:
// Constructors
//- Construct given initial table size
DictionaryBase(const label size = 128);
//- Copy constructor
DictionaryBase(const DictionaryBase&);
//- Move constructor
DictionaryBase(DictionaryBase&&);
//- Construct from Istream using given Istream constructor class
template<class INew>
DictionaryBase(Istream&, const INew&);
//- Construct from Istream using default Istream constructor class
DictionaryBase(Istream&);
// Member Functions
// Search and lookup
//- Search DictionaryBase for given keyword
bool found(const word&) const;
//- Find and return an entry if present, otherwise return nullptr
const T* lookupPtr(const word&) const;
//- Find and return an entry if present, otherwise return nullptr
T* lookupPtr(const word&);
//- Find and return entry
const T* lookup(const word&) const;
//- Find and return entry
T* lookup(const word&);
//- Return the table of contents
wordList toc() const;
//- Return the table of contents as a sorted list
wordList sortedToc() const;
// Editing
//- Add at head of dictionary
void insert(const word&, T*);
//- Add at tail of dictionary
void append(const word&, T*);
//- Remove and return entry specified by keyword.
// Return nullptr if the keyword was not found.
T* remove(const word&);
//- Clear the dictionary
void clear();
//- Transfer the contents of the argument into this DictionaryBase
// and annul the argument.
void transfer(DictionaryBase<IDLListType, T>&);
// Member Operators
void operator=(const DictionaryBase&);
//- Find and return entry
const T* operator[](const word& key) const
{
return lookup(key);
}
//- Find and return entry
T* operator[](const word& key)
{
return lookup(key);
}
// Ostream operator
friend Ostream& operator<< <IDLListType, T>
(
Ostream&,
const DictionaryBase<IDLListType, T>&
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "DictionaryBase.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|