src/foam/containers/HashTables/HashPtrTable/HashPtrTable.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::HashPtrTable
  26
  27 Description
  28     A HashTable specialization for hashing pointers.
  29
  30 SourceFiles
  31     HashPtrTable.C
  32     HashPtrTableIO.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef HashPtrTable_H
  37 #define HashPtrTable_H
  38
  39 #include "HashTable.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 class Istream;
  47 class Ostream;
  48
  49 // Forward declaration of friend functions and operators
  50
  51 template<class T, class Key, class Hash> class HashPtrTable;
  52
  53 template<class T, class Key, class Hash>
  54 Istream& operator>>(Istream&, HashPtrTable<T, Key, Hash>&);
  55
  56 template<class T, class Key, class Hash>
  57 Ostream& operator<<(Ostream&, const HashPtrTable<T, Key, Hash>&);
  58
  59
  60 /*---------------------------------------------------------------------------*\
  61                         Class HashPtrTable Declaration
  62 \*---------------------------------------------------------------------------*/
  63
  64 template<class T, class Key=word, class Hash=string::hash>
  65 class HashPtrTable
  66 :
  67     public HashTable<T*, Key, Hash>
  68 {
  69     // Private Member Functions
  70
  71         //- Read from Istream using given Istream constructor class
  72         template<class INew>
  73         void read(Istream&, const INew& inewt);
  74
  75         //- Read from dictionary using given dictionary constructor class
  76         template<class INew>
  77         void read(const dictionary& dict, const INew& inewt);
  78
  79
  80
  81 public:
  82
  83     typedef typename HashTable<T*, Key, Hash>::iterator iterator;
  84     typedef typename HashTable<T*, Key, Hash>::const_iterator const_iterator;
  85
  86
  87     // Constructors
  88
  89         //- Construct given initial table size
  90         HashPtrTable(const label size = 128);
  91
  92         //- Construct from Istream using given Istream constructor class
  93         template<class INew>
  94         HashPtrTable(Istream&, const INew&);
  95
  96         //- Construct from Istream using default Istream constructor class
  97         HashPtrTable(Istream&);
  98
  99         //- Construct from dictionary using default dictionary constructor
 100         //  class
 101         HashPtrTable(const dictionary&);
 102
 103         //- Construct as copy
 104         HashPtrTable(const HashPtrTable<T, Key, Hash>&);
 105
 106
 107     //- Destructor
 108     ~HashPtrTable();
 109
 110
 111     // Member Functions
 112
 113         // Edit
 114
 115             //- Remove and return the pointer specified by given iterator
 116             T* remove(iterator&);
 117
 118             //- Erase an hashedEntry specified by given iterator
 119             bool erase(iterator&);
 120
 121             //- Clear all entries from table
 122             void clear();
 123
 124             //- Write
 125             void write(Ostream& os) const;
 126
 127
 128     // Member Operators
 129
 130         void operator=(const HashPtrTable<T, Key, Hash>&);
 131
 132
 133     // IOstream Operators
 134
 135         friend Istream& operator>> <T, Key, Hash>
 136         (
 137             Istream&,
 138             HashPtrTable<T, Key, Hash>&
 139         );
 140
 141         friend Ostream& operator<< <T, Key, Hash>
 142         (
 143             Ostream&,
 144             const HashPtrTable<T, Key, Hash>&
 145         );
 146 };
 147
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 } // End namespace Foam
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 #ifdef NoRepository
 156 #   include "HashPtrTable.C"
 157 #endif
 158
 159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 160
 161 #endif
 162
 163 // ************************************************************************* //