142 word headerClassName_;
163 bool registerObject_;
174 void setBad(
const string&);
304 return headerClassName_;
310 return headerClassName_;
320 const string&
note()
const 334 return registerObject_;
340 return registerObject_;
435 template<
class Stream>
436 static inline Stream&
writeBanner(Stream& os,
bool noHint=
false);
439 template<
class Stream>
443 template<
class Stream>
457 return objState_ ==
GOOD;
462 return objState_ ==
BAD;
483 Ostream& operator<<(Ostream& os, const InfoProxy<IOobject>& ip);
fileCheckTypes
Enumeration defining the file checking options.
autoPtr< IOobject > clone() const
Clone.
writeOption
Enumeration defining the write options.
static bool fileNameComponents(const fileName &path, fileName &instance, fileName &local, word &name)
Split path into instance, local, name components.
const word & name() const
Return name.
bool typeHeaderOk(const bool checkType=true)
Read header (uses typeFilePath to find file) and check header.
A class for handling file names.
static Stream & writeBanner(Stream &os, bool noHint=false)
Write the standard OpenFOAM file/dictionary banner.
bool typeGlobal()
Template function for obtaining global status.
void operator=(const IOobject &)
static Stream & writeDivider(Stream &os)
Write the standard file section divider.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
IOobject(const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
Construct from name, instance, registry, io options.
virtual void rename(const word &newName)
Rename.
word member() const
Return member (name without the extension)
objectState
Enumeration defining the valid states of an IOobject.
virtual ~IOobject()
Destructor.
word group() const
Return group (extension part of name)
readOption
Enumeration defining the read options.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
fileName path() const
Return complete path.
fileName localFilePath(const word &typeName) const
Helper for filePath that searches locally.
bool readHeader(Istream &)
Read header.
string & note()
Return non-constant access to the optional note.
A class for handling words, derived from string.
static word groupName(Name name, const word &group)
const fileName & local() const
void setBad(const string &)
Set the object state to bad.
fileName globalFilePath(const word &typeName) const
Helper for filePath that searches up if in parallel.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
static fileCheckTypes fileModificationChecking
Type of file modification checking.
fileName typeFilePath(const IOobject &io)
Template function for obtaining filePath.
const fileName & rootPath() const
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
writeOption writeOpt() const
const fileName & instance() const
static Stream & writeEndDivider(Stream &os)
Write the standard end file divider.
A helper class for outputting values to Ostream.
const Time & time() const
Return time.
TypeName("IOobject")
Runtime type information.
bool writeHeader(Ostream &) const
Write header.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
InfoProxy< IOobject > info() const
Return info proxy.
Registry of regIOobjects.
const objectRegistry & db() const
Return the local objectRegistry.
bool & registerObject()
Register object created from this IOobject with registry if true.
readOption readOpt() const
IOobject unregister(const IOobject &io)
const word & headerClassName() const
Return name of the class name read from header.
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
const fileName & caseName() const
fileName objectPath() const
Return complete path + object name.
void warnNoRereading() const
Helper: warn that type does not support re-reading.