FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

IOMap.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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::IOMap
00026 
00027 Description
00028     A Map of objects of type <T> with automated input and output.
00029 
00030 SourceFiles
00031     IOMap.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef IOMap_H
00036 #define IOMap_H
00037 
00038 #include <OpenFOAM/Map.H>
00039 #include <OpenFOAM/regIOobject.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class IOMap Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 template<class T>
00051 class IOMap
00052 :
00053     public regIOobject,
00054     public Map<T>
00055 {
00056 
00057 public:
00058 
00059     //- Runtime type information
00060     TypeName("Map");
00061 
00062 
00063     // Constructors
00064 
00065         //- Construct from IOobject
00066         IOMap(const IOobject&);
00067 
00068         //- Construct from IOobject and size of Map
00069         IOMap(const IOobject&, const label);
00070 
00071         //- Construct from IOobject and a Map
00072         IOMap(const IOobject&, const Map<T>&);
00073 
00074         //- Construct by transferring the Map contents
00075         IOMap(const IOobject&, const Xfer<Map<T> >&);
00076 
00077 
00078     // Destructor
00079 
00080         virtual ~IOMap();
00081 
00082 
00083     // Member functions
00084 
00085         bool writeData(Ostream&) const;
00086 
00087 
00088     // Member operators
00089 
00090         //- Assignment of other IOMap's entries to this IOMap
00091         void operator=(const IOMap<T>&);
00092 
00093         //- Assignment of other Map's entries to this IOMap
00094         void operator=(const Map<T>&);
00095 };
00096 
00097 
00098 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00099 
00100 } // End namespace Foam
00101 
00102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00103 
00104 #ifdef NoRepository
00105 #   include <OpenFOAM/IOMap.C>
00106 #endif
00107 
00108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00109 
00110 #endif
00111 
00112 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines