src/OpenFOAM/db/IOobjects/IOPtrList/IOPtrList.H

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