src/foam/db/IOobjects/IOPtrList/IOPtrList.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::IOPtrList
  26
  27 Description
  28     A PtrList of objects of type \<T\> with automated input and output.
  29
  30 SourceFiles
  31     IOPtrList.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef IOPtrList_H
  36 #define IOPtrList_H
  37
  38 #include "PtrList.H"
  39 #include "regIOobject.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class IOPtrList Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class T>
  51 class IOPtrList
  52 :
  53     public regIOobject,
  54     public PtrList<T>
  55 {
  56
  57 public:
  58
  59     //- Runtime type information
  60     TypeName("PtrList");
  61
  62
  63     // Constructors
  64
  65         //- Construct from IOobject using given Istream constructor class
  66         template<class INew>
  67         IOPtrList(const IOobject&, const INew&);
  68
  69         //- Construct from IOobject
  70         IOPtrList(const IOobject&);
  71
  72         //- Construct from IOobject with given size
  73         IOPtrList(const IOobject&, const label);
  74
  75         //- Construct from IOobject and a PtrList
  76         IOPtrList(const IOobject&, const PtrList<T>&);
  77
  78         //- Construct by transferring the PtrList contents
  79         IOPtrList(const IOobject&, const Xfer<PtrList<T> >&);
  80
  81
  82     // Destructor
  83
  84         virtual ~IOPtrList();
  85
  86
  87     // Member functions
  88
  89         bool writeData(Ostream&) const;
  90
  91
  92     // Member operators
  93
  94         void operator=(const IOPtrList<T>&);
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace Foam
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 #ifdef NoRepository
 105 #   include "IOPtrList.C"
 106 #endif
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 #endif
 111
 112 // ************************************************************************* //