![]() |
|
Public Types | |
enum | objectState { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | readOption { MUST_READ, READ_IF_PRESENT, NO_READ } |
Enumeration defining the read options. More... | |
enum | writeOption { AUTO_WRITE = 0, NO_WRITE = 1 } |
Enumeration defining the write options. More... | |
Public Member Functions | |
TypeName ("IOobject") | |
Runtime type information. | |
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. | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from name, instance, local, registry, io options. | |
autoPtr< IOobject > | clone () const |
Clone. | |
virtual | ~IOobject () |
const Time & | time () const |
Return time. | |
const objectRegistry & | db () const |
Return the local objectRegistry. | |
const word & | name () const |
Return name. | |
const word & | headerClassName () const |
Return name of the class name read from header. | |
string & | note () |
Return non-constant access to the optional note. | |
const string & | note () const |
Return the optional note. | |
virtual void | rename (const word &newName) |
Rename. | |
bool | registerObject () const |
Register object created from this IOobject with registry if true. | |
readOption | readOpt () const |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () const |
fileName | path () const |
Return complete path. | |
fileName | path (const word &instance, const fileName &local="") const |
Return complete path with alternative instance and local. | |
fileName | objectPath () const |
Return complete path + object name. | |
bool | readHeader (Istream &) |
Read header. | |
bool | headerOk () |
Read and check header info. | |
bool | writeHeader (Ostream &) const |
Write header. | |
bool | good () const |
bool | bad () const |
InfoProxy< IOobject > | info () const |
Return info proxy. | |
void | operator= (const IOobject &) |
Protected Member Functions | |
Istream * | objectStream (const fileName &) |
Construct and return an IFstream for the given file. | |
Istream * | objectStream () |
Construct and return an IFstream for the object. | |
void | setBad (const string &) |
Set the object state to bad. |
|
Enumeration defining the valid states of an IOobject.
Definition at line 100 of file IOobject.H. |
|
Enumeration defining the read options.
Definition at line 107 of file IOobject.H. |
|
Enumeration defining the write options.
Definition at line 115 of file IOobject.H. |
|
Construct from name, instance, registry, io options.
|
|
Construct from name, instance, local, registry, io options.
|
|
Definition at line 217 of file IOobject.H. |
|
Definition at line 351 of file IOobject.H. |
|
Reimplemented in Time. |
|
Clone.
Reimplemented in topoSet. Definition at line 209 of file IOobject.H. |
|
Return the local objectRegistry.
Reimplemented in faMesh. |
|
Definition at line 346 of file IOobject.H. |
|
Return name of the class name read from header.
Definition at line 238 of file IOobject.H. |
|
Read and check header info.
|
|
Return info proxy. Used to print token information to a stream Definition at line 363 of file IOobject.H. |
|
Definition at line 302 of file IOobject.H. |
|
Definition at line 297 of file IOobject.H. |
|
Definition at line 307 of file IOobject.H. References Foam::name(). |
Here is the call graph for this function:
|
Return name.
Reimplemented in IOdictionary, and fvMesh. Definition at line 232 of file IOobject.H. |
|
Return the optional note.
Definition at line 250 of file IOobject.H. |
|
Return non-constant access to the optional note.
Definition at line 244 of file IOobject.H. |
|
Return complete path + object name.
Definition at line 323 of file IOobject.H. |
|
Construct and return an IFstream for the object. The results is NULL if the stream constuction failed |
|
Construct and return an IFstream for the given file. The results is NULL if the stream constuction failed |
|
Reimplemented in regIOobject. |
|
Return complete path with alternative instance and local.
|
|
Return complete path.
Reimplemented in Time. |
|
Read header.
|
|
Definition at line 275 of file IOobject.H. |
|
Definition at line 270 of file IOobject.H. |
|
Register object created from this IOobject with registry if true.
Definition at line 262 of file IOobject.H. |
|
Rename.
Reimplemented in regIOobject. Definition at line 256 of file IOobject.H. |
|
Reimplemented in Time. |
|
Set the object state to bad.
|
|
Return time.
Reimplemented in objectRegistry, fvMesh, and faMesh. |
|
Runtime type information.
|
|
Write header.
|
|
Definition at line 285 of file IOobject.H. |
|
Definition at line 280 of file IOobject.H. |