| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / 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 | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| 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 | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |