src/OpenFOAM/containers/HashTables/HashPtrTable/HashPtrTable.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::HashPtrTable
  27
  28 Description
  29     A HashTable specialization for hashing pointers.
  30
  31 SourceFiles
  32     HashPtrTable.C
  33     HashPtrTableIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef HashPtrTable_H
  38 #define HashPtrTable_H
  39
  40 #include "HashTable.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 class Istream;
  48 class Ostream;
  49
  50 // Forward declaration of friend functions and operators
  51
  52 template<class T, class Key, class Hash> class HashPtrTable;
  53
  54 template<class T, class Key, class Hash>
  55 Istream& operator>>(Istream&, HashPtrTable<T, Key, Hash>&);
  56
  57 template<class T, class Key, class Hash>
  58 Ostream& operator<<(Ostream&, const HashPtrTable<T, Key, Hash>&);
  59
  60
  61 /*---------------------------------------------------------------------------*\
  62                         Class HashPtrTable Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 template<class T, class Key=word, class Hash=string::hash>
  66 class HashPtrTable
  67 :
  68     public HashTable<T*, Key, Hash>
  69 {
  70     // Private member functions
  71
  72         //- Read from Istream using given Istream constructor class
  73         template<class INew>
  74         void read(Istream&, const INew& inewt);
  75
  76
  77 public:
  78
  79     typedef typename HashTable<T*, Key, Hash>::iterator iterator;
  80     typedef typename HashTable<T*, Key, Hash>::const_iterator const_iterator;
  81
  82
  83     // Constructors
  84
  85         //- Construct given initial table size
  86         HashPtrTable(const label size = 128);
  87
  88         //- Construct from Istream using given Istream constructor class
  89         template<class INew>
  90         HashPtrTable(Istream&, const INew&);
  91
  92         //- Construct from Istream using default Istream constructor class
  93         HashPtrTable(Istream&);
  94
  95         //- Construct as copy
  96         HashPtrTable(const HashPtrTable<T, Key, Hash>&);
  97
  98
  99     // Destructor
 100
 101         ~HashPtrTable();
 102
 103
 104     // Member Functions
 105
 106         // Edit
 107
 108             //- Remove and return the pointer specified by given iterator
 109             T* remove(iterator&);
 110
 111             //- Erase an hashedEntry specified by given iterator
 112             bool erase(iterator&);
 113
 114             //- Clear all entries from table
 115             void clear();
 116
 117
 118     // Member Operators
 119
 120         void operator=(const HashPtrTable<T, Key, Hash>&);
 121
 122
 123     // IOstream Operators
 124
 125         friend Istream& operator>> <T, Key, Hash>
 126         (
 127             Istream&,
 128             HashPtrTable<T, Key, Hash>&
 129         );
 130
 131         friend Ostream& operator<< <T, Key, Hash>
 132         (
 133             Ostream&,
 134             const HashPtrTable<T, Key, Hash>&
 135         );
 136 };
 137
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 } // End namespace Foam
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 #ifdef NoRepository
 146 #   include "HashPtrTable.C"
 147 #endif
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 #endif
 152
 153 // ************************************************************************* //