src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::DictionaryBase
  27
  28 Description
  29     Base dictionary class templated on both the form of doubly-linked list
  30     it uses as well as the type it holds.
  31
  32     The double templating allows for the instantiation of forms with or
  33     without storage management.
  34
  35 Note
  36     The IDLListType parameter should itself be a template but this confused
  37     gcc 2.95.2 so it has to be instantiated for T when an instantiation of
  38     DictionaryBase is requested
  39
  40 See Also
  41     Dictionary and UDictionary
  42
  43 SourceFiles
  44     DictionaryBase.C
  45     DictionaryBaseIO.C
  46
  47 \*---------------------------------------------------------------------------*/
  48
  49 #ifndef DictionaryBase_H
  50 #define DictionaryBase_H
  51
  52 #include "HashTable.H"
  53 #include "wordList.H"
  54
  55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  56
  57 namespace Foam
  58 {
  59
  60 // Forward declaration of friend functions and operators
  61
  62 template<class IDLListType, class T>
  63 class DictionaryBase;
  64
  65 template<class IDLListType, class T>
  66 Ostream& operator<<(Ostream&, const DictionaryBase<IDLListType, T>&);
  67
  68
  69 /*---------------------------------------------------------------------------*\
  70                       Class DictionaryBase Declaration
  71 \*---------------------------------------------------------------------------*/
  72
  73 template<class IDLListType, class T>
  74 class DictionaryBase
  75 :
  76     public IDLListType
  77 {
  78     // Private data
  79
  80         //- HashTable of the entries held on the IDLListType for quick lookup
  81         HashTable<T*> hashedTs_;
  82
  83
  84     // Private Member functions
  85
  86         // Add the IDLListType entries into the HashTable
  87         void addEntries();
  88
  89
  90 public:
  91
  92     // Constructors
  93
  94         //- Null constructor
  95         DictionaryBase();
  96
  97         //- Copy construct
  98         DictionaryBase(const DictionaryBase&);
  99
 100         //- Construct from Istream using given Istream constructor class
 101         template<class INew>
 102         DictionaryBase(Istream&, const INew&);
 103
 104         //- Construct from Istream using default Istream constructor class
 105         DictionaryBase(Istream&);
 106
 107
 108     // Member functions
 109
 110         // Search and lookup
 111
 112             //- Search DictionaryBase for given keyword
 113             bool found(const word&) const;
 114
 115             //- Find and return an entry if present, otherwise return NULL
 116             const T* lookupPtr(const word&) const;
 117
 118             //- Find and return an entry if present, otherwise return NULL
 119             T* lookupPtr(const word&);
 120
 121             //- Find and return entry
 122             const T* lookup(const word&) const;
 123
 124             //- Find and return entry
 125             T* lookup(const word&);
 126
 127             //- Return the table of contents
 128             wordList toc() const;
 129
 130
 131         // Editing
 132
 133             //- Add at head of dictionary
 134             void insert(const word&, T*);
 135
 136             //- Add at tail of dictionary
 137             void append(const word&, T*);
 138
 139             //- Remove and return entry specified by keyword.
 140             //  Return NULL if the keyword was not found.
 141             T* remove(const word&);
 142
 143             //- Clear the dictionary
 144             void clear();
 145
 146             //- Transfer the contents of the argument into this DictionaryBase
 147             //  and annull the argument.
 148             void transfer(DictionaryBase<IDLListType, T>&);
 149
 150     // Member operators
 151
 152         void operator=(const DictionaryBase&);
 153
 154         //- Find and return entry
 155         const T* operator[](const word& key) const
 156         {
 157             return lookup(key);
 158         }
 159
 160         //- Find and return entry
 161         T* operator[](const word& key)
 162         {
 163             return lookup(key);
 164         }
 165
 166
 167     // Ostream operator
 168
 169         friend Ostream& operator<< <IDLListType, T>
 170         (
 171             Ostream&,
 172             const DictionaryBase<IDLListType, T>&
 173         );
 174 };
 175
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 } // End namespace Foam
 180
 181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 182
 183 #ifdef NoRepository
 184 #   include "DictionaryBase.C"
 185 #endif
 186
 187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 188
 189 #endif
 190
 191 // ************************************************************************* //