OpenFOAM logo
Open Source CFD Toolkit

IOPtrList.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     IOPtrList
00027 
00028 Description
00029     An IOPtrList of a given type is a PtrList of that type which supports
00030     automated input and output.
00031 
00032 SourceFiles
00033     IOPtrList.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef IOPtrList_H
00038 #define IOPtrList_H
00039 
00040 #include "PtrList.H"
00041 #include "regIOobject.H"
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                            Class IOPtrList Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 template<class T>
00053 class IOPtrList
00054 :
00055     public regIOobject,
00056     public PtrList<T>
00057 {
00058 
00059 public:
00060 
00061     //- Runtime type information
00062     TypeName("PtrList");
00063 
00064 
00065     // Constructors
00066 
00067         //- Construct from IOobject using given Istream constructor class
00068         template<class INew>
00069         IOPtrList(const IOobject&, const INew&);
00070 
00071         //- Construct from IOobject
00072         IOPtrList(const IOobject&);
00073 
00074         //- Construct from IOobject and a PtrList
00075         IOPtrList(const IOobject&, const PtrList<T>&);
00076 
00077 
00078     // Member functions
00079 
00080         bool writeData(Ostream&) const;
00081 
00082 
00083     // Member operators
00084 
00085         void operator=(const IOPtrList<T>&);
00086 };
00087 
00088 
00089 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00090 
00091 } // End namespace Foam
00092 
00093 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00094 
00095 #ifdef NoRepository
00096 #   include "IOPtrList.C"
00097 #endif
00098 
00099 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00100 
00101 #endif
00102 
00103 // ************************************************************************* //
For further information go to www.openfoam.org