openfoam/src/OpenFOAM/db/IOobjects/IOMap/IOMap.H
2008-10-21 15:04:18 +01:00

114 lines
3.0 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2008 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::IOMap
Description
A Map of objects of type \<T\> with automated input and output.
SourceFiles
IOMap.C
\*---------------------------------------------------------------------------*/
#ifndef IOMap_H
#define IOMap_H
#include "Map.H"
#include "regIOobject.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class IOMap Declaration
\*---------------------------------------------------------------------------*/
template<class T>
class IOMap
:
public regIOobject,
public Map<T>
{
public:
//- Runtime type information
TypeName("Map");
// Constructors
//- Construct from IOobject
IOMap(const IOobject&);
//- Construct from IOobject and size of Map
IOMap(const IOobject&, const label);
//- Construct from IOobject and a Map
IOMap(const IOobject&, const Map<T>&);
//- Construct by transferring the Map contents
IOMap(const IOobject&, const xfer<Map<T> >&);
// Destructor
virtual ~IOMap();
// Member functions
bool writeData(Ostream&) const;
// Member operators
//- Assignment of other IOMap's entries to this IOMap
void operator=(const IOMap<T>&);
//- Assignment of other Map's entries to this IOMap
void operator=(const Map<T>&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
# include "IOMap.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //