src/OpenFOAM/containers/LinkedLists/accessTypes/ILList/ILList.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::ILList
  27
  28 Description
  29     Template class for intrusive linked lists.
  30
  31 SourceFiles
  32     ILList.C
  33     ILListIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef ILList_H
  38 #define ILList_H
  39
  40 #include "UILList.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 LListBase, class T> class ILList;
  53
  54 template<class LListBase, class T> Istream& operator>>
  55 (
  56     Istream&,
  57     ILList<LListBase, T>&
  58 );
  59
  60
  61 /*---------------------------------------------------------------------------*\
  62                            Class ILList Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 template<class LListBase, class T>
  66 class ILList
  67 :
  68     public UILList<LListBase, T>
  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&);
  75
  76
  77 public:
  78
  79     // Constructors
  80
  81         //- Null construct
  82         ILList()
  83         {}
  84
  85         //- Construct given initial T
  86         ILList(T* a)
  87         :
  88             UILList<LListBase, T>(a)
  89         {}
  90
  91         //- Construct from Istream
  92         ILList(Istream&);
  93
  94         //- Construct as copy
  95         ILList(const ILList<LListBase, T>&);
  96
  97         //- Copy constructor with additional argument for clone
  98         template<class CloneArg>
  99         ILList(const ILList<LListBase, T>& lst, const CloneArg& cloneArg)
 100         #ifdef __INTEL_COMPILER
 101         :
 102             UILList<LListBase, T>()
 103         {
 104             for
 105             (
 106                 typename UILList<LListBase, T>::const_iterator iter =
 107                     lst.begin();
 108                 iter != lst.end();
 109                 ++iter
 110             )
 111             {
 112                 append(iter().clone(cloneArg).ptr());
 113             }
 114         }
 115         #else
 116         ;
 117         #endif
 118
 119         //- Construct from Istream using given Istream constructor class
 120         template<class INew>
 121         ILList(Istream&, const INew&);
 122
 123
 124     // Destructor
 125
 126         ~ILList();
 127
 128
 129     // Member Functions
 130
 131         // Edit
 132
 133             //- Remove the head element specified from the list and delete it
 134             bool eraseHead();
 135
 136             //- Remove the specified element from the list and delete it
 137             bool erase(T* p);
 138
 139             //- Clear the contents of the list
 140             void clear();
 141
 142             //- Transfer the contents of the argument into this List
 143             //  and annull the argument list.
 144             void transfer(ILList<LListBase, T>&);
 145
 146
 147     // Member operators
 148
 149         void operator=(const ILList<LListBase, T>&);
 150
 151
 152     // Istream operator
 153
 154         //- Read List from Istream, discarding contents of existing List.
 155         friend Istream& operator>> <LListBase, T>
 156         (
 157             Istream&,
 158             ILList<LListBase, T>&
 159         );
 160 };
 161
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 } // End namespace Foam
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 #ifdef NoRepository
 170 #   include "ILList.C"
 171 #endif
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #endif
 176
 177 // ************************************************************************* //