Go to the documentation of this file.
54 namespace functionEntries
58 namespace fileOperations
60 class uncollatedFileOperation;
61 class masterUncollatedFileOperation;
97 bool ownedByRegistry_;
112 Istream& readStream(
const bool valid =
true);
186 inline static Type&
store(Type*
p);
200 inline void release(
const bool unregister =
false);
261 Istream& readStream(
const word&,
const bool valid =
true);
308 virtual bool write(
const bool valid =
true)
const;
314 virtual bool global()
const
Defines the attributes of an object for which implicit objectRegistry management is supported,...
virtual bool writeObject(IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool valid) const
Write using given format, version and compression.
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.
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.
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.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Representation of a major/minor version number.
virtual bool modified() const
Return true if the object's file (or files for objectRegistry)
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)....
virtual bool readIfModified()
Read object if modified (as set by call to modified)
streamFormat
Data format (ascii | binary)
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...
void store()
Transfer ownership of this object to its registry.
TypeName("regIOobject")
Runtime type information.
fileOperations that performs all file operations on the master processor. Requires the calls to be pa...
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.
Dictionary entry that contains C++ OpenFOAM code that is compiled to generate the entry itself....
compressionType
Compression treatment (UNCOMPRESSED | COMPRESSED)
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.