Go to the documentation of this file.
61 namespace functionEntries
65 namespace fileOperations
67 class uncollatedFileOperation;
99 bool ownedByRegistry_;
117 void readStream(
const bool valid);
188 inline static Type&
store(Type*
p);
228 inline void release(
const bool unregister =
false);
304 Istream& readStream(const
word&, const
bool valid = true);
349 virtual
bool write(const
bool valid = true) const;
355 virtual
bool global()
const
387 #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.
A class for handling file names.
void release(const bool unregister=false)
Release ownership of this object from its registry.
virtual void updateMetaData()
Update internal meta-data (eg, prior to writing)
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.
virtual void addWatch()
Add file watch on object (if registered and READ_IF_MODIFIED)
virtual bool read()
Read object.
bool checkIn()
Add object to registry, if not already registered.
virtual bool global() const
Is object global.
label eventNo() const
Event number at last update.
const dictionary * findMetaData() const noexcept
Return pointer to meta-data or nullptr.
regIOobject(const IOobject &io, const bool isTimeObject=false)
virtual bool modified() const
virtual bool write(const bool valid=true) const
Write using setting from DB.
dictionary & getMetaData() noexcept
Get or create meta-data.
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)
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
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.
void removeMetaData()
Remove meta-data.
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.
bool readHeaderOk(const IOstreamOption::streamFormat fmt, const word &typeName)
Helper: check readOpt flags and read if necessary.
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)