Go to the documentation of this file.
155 word headerClassName_;
176 bool registerObject_;
185 unsigned short labelByteSize_;
188 unsigned short scalarByteSize_;
242 template<
class StringType>
253 template<
class StringType>
274 const word& ioName =
""
384 inline const string&
note()
const;
387 inline string&
note();
475 const word& typeName,
484 const word& typeName,
501 const bool checkType =
true,
503 const bool verbose =
true
532 inline bool good()
const;
534 inline bool bad()
const;
555 inline bool IOobject::isHeaderClassName<void>()
const
static autoPtr< T > New(Args &&... args)
Construct autoPtr of T with forwarding arguments.
Defines the attributes of an object for which implicit objectRegistry management is supported,...
fileCheckTypes
Enumeration defining the file checking options.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
static word scopedName(StringType scope, const word &name)
Create scope:name or scope_name string.
const word & name() const
Return name.
unsigned scalarByteSize() const
The scalar byte-size, possibly read from the header.
fileName localFilePath(const word &typeName, const bool search=true) const
Helper for filePath that searches locally.
A class for handling words, derived from Foam::string.
static const Enum< fileCheckTypes > fileCheckTypesNames
Names for the fileCheckTypes.
A helper class for outputting values to Ostream.
A class for handling file names.
gmvFile<< "tracers "<< particles.size()<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().x()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().y()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().z()<< " ";}gmvFile<< nl;forAll(lagrangianScalarNames, i){ word name=lagrangianScalarNames[i];IOField< scalar > s(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
virtual ~IOobject()=default
Destructor.
static Ostream & writeBanner(Ostream &os, bool noHint=false)
Write the standard OpenFOAM file/dictionary banner.
bool typeHeaderOk(const bool checkType=true, const bool search=true, const bool verbose=true)
Read header (uses typeFilePath to find file) and check its info.
static Ostream & writeEndDivider(Ostream &os)
Write the standard end file divider.
const fileName & rootPath() const
const fileName & instance() const
bool isHeaderClassName() const
Test if headerClassName() equals Type::typeName.
static fileCheckTypes fileModificationChecking
Type of file modification checking.
static char scopeSeparator
Character for scoping object names (':' or '_')
IOobject(const IOobject &)=default
Copy construct.
TypeName("IOobject")
Declare type-name, virtual type (with debug switch)
unsigned labelByteSize() const
The label byte-size, possibly read from the header.
const Time & time() const
Return time.
InfoProxy< IOobject > info() const
Return info proxy.
objectState
Enumeration defining the valid states of an IOobject.
bool readHeader(Istream &is)
Read header.
const objectRegistry & db() const
Return the local objectRegistry.
Registry of regIOobjects.
Ostream & operator<<(Ostream &, const boundaryPatch &p)
Write boundaryPatch as dictionary entries (without surrounding braces)
writeOption
Enumeration defining the write options.
bool registerObject() const
Should object created with this IOobject be registered?
void warnNoRereading() const
Helper: warn that type does not support re-reading.
const fileName & local() const
autoPtr< IOobject > clone(const objectRegistry ®istry) const
Clone resetting registry.
writeOption writeOpt() const
The write option.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
const fileName & caseName() const
bool globalObject() const
Is object same for all processors?
autoPtr< IOobject > clone() const
Clone.
static IOobject selectIO(const IOobject &io, const fileName &altFile, const word &ioName="")
Return the IOobject, but also consider an alternative file name.
static bool fileNameComponents(const fileName &path, fileName &instance, fileName &local, word &name)
Split path into instance, local, name components.
fileName globalFilePath(const word &typeName, const bool search=true) const
Helper for filePath that searches up if in parallel.
virtual void rename(const word &newName)
Rename.
static const fileName null
An empty fileName.
void operator=(const IOobject &io)
const word & headerClassName() const
Return name of the class name read from header.
fileName typeFilePath(const IOobject &io, const bool search=true)
Template function for obtaining local or global filePath.
const string & note() const
Return the optional note.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
static Ostream & writeDivider(Ostream &os)
Write the standard file section divider.
word member() const
Return member (name without the extension)
readOption readOpt() const
The read option.
fileName search(const word &file, const fileName &directory)
Recursively search the given directory for the file.
word group() const
Return group (extension part of name)
bool typeGlobal()
Template function for obtaining global vs. local status.
void setBad(const string &s)
Set the object state to bad.
bool writeHeader(Ostream &os) const
Write header.
readOption
Enumeration defining the read options.
static word groupName(StringType base, const word &group)
Create dot-delimited name.group string.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
fileName objectPath() const
The complete path + object name.
fileName path() const
The complete path.