302 lines
8 KiB
C++
302 lines
8 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
|
\\/ 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 3 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, see <http://www.gnu.org/licenses/>.
|
|
|
|
Class
|
|
Foam::regIOobject
|
|
|
|
Description
|
|
regIOobject is an abstract class derived from IOobject to handle
|
|
automatic object registration with the objectRegistry.
|
|
|
|
SourceFiles
|
|
regIOobject.C
|
|
regIOobjectRead.C
|
|
regIOobjectWrite.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef regIOobject_H
|
|
#define regIOobject_H
|
|
|
|
#include "IOobject.H"
|
|
#include "typeInfo.H"
|
|
#include "OSspecific.H"
|
|
#include "NamedEnum.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
namespace functionEntries
|
|
{
|
|
class codeStream;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class regIOobject Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class regIOobject
|
|
:
|
|
public IOobject
|
|
{
|
|
|
|
public:
|
|
|
|
//- Types of communications
|
|
enum fileCheckTypes
|
|
{
|
|
timeStamp,
|
|
timeStampMaster,
|
|
inotify,
|
|
inotifyMaster
|
|
};
|
|
|
|
static const NamedEnum<fileCheckTypes, 4> fileCheckTypesNames;
|
|
|
|
|
|
protected:
|
|
|
|
//- To flag master-only reading of objects
|
|
static bool masterOnlyReading;
|
|
|
|
|
|
private:
|
|
|
|
// Private data
|
|
|
|
//- Is this object registered with the registry
|
|
bool registered_;
|
|
|
|
//- Is this object owned by the registry
|
|
bool ownedByRegistry_;
|
|
|
|
//- Modification watch index
|
|
mutable label watchIndex_;
|
|
|
|
//- eventNo of last update
|
|
label eventNo_;
|
|
|
|
//- Istream for reading
|
|
Istream* isPtr_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Return Istream
|
|
Istream& readStream();
|
|
|
|
//- Dissallow assignment
|
|
void operator=(const regIOobject&);
|
|
|
|
|
|
public:
|
|
|
|
//- Declare friendship with any classes that need access to
|
|
// masterOnlyReading
|
|
friend class functionEntries::codeStream;
|
|
|
|
|
|
// Static data
|
|
|
|
//- Runtime type information
|
|
TypeName("regIOobject");
|
|
|
|
static int fileModificationSkew;
|
|
|
|
static fileCheckTypes fileModificationChecking;
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from IOobject. Optional flag for if IOobject is the
|
|
// top level regIOobject.
|
|
regIOobject(const IOobject&, const bool isTime = false);
|
|
|
|
//- Construct as copy
|
|
regIOobject(const regIOobject&);
|
|
|
|
//- Construct as copy, transferring registry registration to copy
|
|
// if registerCopy is true
|
|
regIOobject(const regIOobject&, bool registerCopy);
|
|
|
|
//- Construct as copy with new name, transfering registry registration
|
|
// to copy as specified
|
|
regIOobject(const word& newName, const regIOobject&, bool registerCopy);
|
|
|
|
//- Construct as copy with new IO parameters
|
|
regIOobject(const IOobject&, const regIOobject&);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~regIOobject();
|
|
|
|
|
|
// Member functions
|
|
|
|
// Registration
|
|
|
|
//- Add object to registry
|
|
bool checkIn();
|
|
|
|
//- Remove object from registry
|
|
bool checkOut();
|
|
|
|
//- Is this object owned by the registry?
|
|
inline bool ownedByRegistry() const;
|
|
|
|
//- Transfer ownership of this object to its registry
|
|
inline void store();
|
|
|
|
//- Transfer ownership of the given object pointer to its registry
|
|
// and return reference to object.
|
|
template<class Type>
|
|
inline static Type& store(Type*);
|
|
|
|
//- Transfer ownership of the given object pointer to its registry
|
|
// and return reference to object.
|
|
template<class Type>
|
|
inline static Type& store(autoPtr<Type>&);
|
|
|
|
//- Release ownership of this object from its registry
|
|
inline void release();
|
|
|
|
|
|
// Dependency checking
|
|
|
|
//- Event number at last update.
|
|
inline label eventNo() const;
|
|
|
|
//- Event number at last update.
|
|
inline label& eventNo();
|
|
|
|
//- Return true if up-to-date with respect to given object
|
|
// otherwise false
|
|
bool upToDate(const regIOobject&) const;
|
|
|
|
//- Return true if up-to-date with respect to given objects
|
|
// otherwise false
|
|
bool upToDate
|
|
(
|
|
const regIOobject&,
|
|
const regIOobject&
|
|
) const;
|
|
|
|
//- Return true if up-to-date with respect to given objects
|
|
// otherwise false
|
|
bool upToDate
|
|
(
|
|
const regIOobject&,
|
|
const regIOobject&,
|
|
const regIOobject&
|
|
) const;
|
|
|
|
//- Return true if up-to-date with respect to given objects
|
|
// otherwise false
|
|
bool upToDate
|
|
(
|
|
const regIOobject&,
|
|
const regIOobject&,
|
|
const regIOobject&,
|
|
const regIOobject&
|
|
) const;
|
|
|
|
//- Set up to date (obviously)
|
|
void setUpToDate();
|
|
|
|
|
|
// Edit
|
|
|
|
//- Rename
|
|
virtual void rename(const word& newName);
|
|
|
|
|
|
// Reading
|
|
|
|
//- Return Istream and check object type against that given
|
|
Istream& readStream(const word&);
|
|
|
|
//- Close Istream
|
|
void close();
|
|
|
|
//- Virtual readData function.
|
|
// Must be defined in derived types for which
|
|
// re-reading is required
|
|
virtual bool readData(Istream&);
|
|
|
|
//- Read object
|
|
virtual bool read();
|
|
|
|
//- Return file-monitoring handle
|
|
inline label watchIndex() const;
|
|
|
|
//- Return file-monitoring handle
|
|
inline label& watchIndex();
|
|
|
|
//- Return true if the object's file (or files for objectRegistry)
|
|
// have been modified. (modified state is cached by Time)
|
|
virtual bool modified() const;
|
|
|
|
//- Read object if modified (as set by call to modified)
|
|
virtual bool readIfModified();
|
|
|
|
|
|
// Writing
|
|
|
|
//- Pure virtual writaData function.
|
|
// Must be defined in derived types
|
|
virtual bool writeData(Ostream&) const = 0;
|
|
|
|
//- Write using given format, version and compression
|
|
virtual bool writeObject
|
|
(
|
|
IOstream::streamFormat,
|
|
IOstream::versionNumber,
|
|
IOstream::compressionType
|
|
) const;
|
|
|
|
//- Write using setting from DB
|
|
virtual bool write() const;
|
|
|
|
|
|
// Member operators
|
|
|
|
void operator=(const IOobject&);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "regIOobjectI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|