Go to the documentation of this file.
59 namespace functionEntries
63 namespace fileOperations
65 class uncollatedFileOperation;
101 bool ownedByRegistry_;
116 Istream& readStream(
const bool valid =
true);
191 inline static Type&
store(Type*
p);
231 inline void release(
const bool unregister =
false);
292 Istream& readStream(
const word&,
const bool valid =
true);
337 virtual bool write(
const bool valid =
true)
const;
343 virtual bool global()
const
375 #include "regIOobjectI.H"
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Functions used by OpenFOAM that are specific to POSIX compliant operating systems and need to be repl...
A class for handling words, derived from Foam::string.
Istream * objectStream()
Construct and return an IFstream for the object.
A class for handling file names.
void release(const bool unregister=false)
Release ownership of this object from its registry.
A class for managing temporary objects.
bool upToDate(const regIOobject &) const
Return true if up-to-date with respect to given object.
const labelList & watchIndices() const
Return file-monitoring handles.
virtual bool writeData(Ostream &) const =0
Pure virtual writeData function.
static float fileModificationSkew
virtual void addWatch()
Add file watch on object (if registered and READ_IF_MODIFIED)
regIOobject(const IOobject &io, const bool isTime=false)
virtual bool read()
Read object.
bool checkIn()
Add object to registry, if not already registered.
An IOstream is an abstract base class for all input/output systems; be they streams,...
static int maxFileModificationPolls
virtual bool global() const
Is object global.
label eventNo() const
Event number at last update.
bool readHeaderOk(const IOstream::streamFormat PstreamFormat, const word &typeName)
Helper: check readOpt flags and read if necessary.
virtual bool modified() const
virtual bool write(const bool valid=true) const
Write using setting from DB.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
The IOstreamOption is a simple container for options an IOstream can normally have.
virtual bool readIfModified()
Read object if modified (as set by call to modified)
streamFormat
Data format (ascii | binary)
virtual bool writeObject(IOstreamOption streamOpt, const bool valid) const
Write using stream options.
bool ownedByRegistry() const
Is this object owned by the registry?
static bool masterOnlyReading
To flag master-only reading of objects.
void setUpToDate()
Set as up-to-date.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
TypeName("regIOobject")
Runtime type information.
bool checkOut()
Remove all file watches and remove object from registry.
void close()
Close Istream.
fileOperation that assumes file operations are local.
virtual void rename(const word &newName)
Rename.
virtual fileName filePath() const
Return complete path + object name if the file exists.
class FOAM_DEPRECATED_FOR(2017-05, "Foam::Enum") NamedEnum
Dictionary entry that contains C++ OpenFOAM code that is compiled to generate the entry itself....
virtual bool readData(Istream &)
Virtual readData function.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
virtual ~regIOobject()
Destructor.
bool headerOk()
Read and check header info.
A class for managing references or pointers (no reference counting)