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