FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

IOdictionary Class Reference

IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionality via the objectRegistry. To facilitate IO, IOdictioanry is provided with a constructor from IOobject and writeData and write functions. More...

#include <OpenFOAM/IOdictionary.H>


Detailed Description

IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionality via the objectRegistry. To facilitate IO, IOdictioanry is provided with a constructor from IOobject and writeData and write functions.

Source files

Definition at line 54 of file IOdictionary.H.

Inheritance diagram for IOdictionary:
Collaboration diagram for IOdictionary:

List of all members.

Public Member Functions

 TypeName ("dictionary")
 IOdictionary (const IOobject &)
 Construct given an IOobject.
 IOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary.
virtual  ~IOdictionary ()
const word &  name () const
 Name function is needed to disambiguate those inherited.
bool  readData (Istream &)
 ReadData function required for regIOobject read operation.
bool  writeData (Ostream &) const
 WriteData function required for regIOobject write operation.
virtual bool  write () const
 Write using setting from DB.
void  operator= (const IOdictionary &)
 Assignment of other IOdictionary's entries to this IOdictionary.

Constructor & Destructor Documentation

~IOdictionary (  ) [virtual]

Definition at line 84 of file IOdictionary.C.


Member Function Documentation

TypeName ( "dictionary"    )
const Foam::word & name (  ) const

Name function is needed to disambiguate those inherited.

from regIOobject and dictionary

Reimplemented from dictionaryName.

Reimplemented in fvMesh, and IOOutputFilter< OutputFilter >.

Definition at line 90 of file IOdictionary.C.

References IOobject::name().

Referenced by IOdictionary::IOdictionary().

bool readData ( Istream &   is  ) [virtual]

ReadData function required for regIOobject read operation.

Reimplemented from regIOobject.

Definition at line 36 of file IOdictionaryIO.C.

References IOstream::bad().

bool writeData ( Ostream &   os  ) const [virtual]

WriteData function required for regIOobject write operation.

Implements regIOobject.

Definition at line 43 of file IOdictionaryIO.C.

References IOstream::good(), and dictionary::write().

bool write (  ) const [virtual]

Write using setting from DB.

Reimplemented from regIOobject.

Reimplemented in fvMesh.

Definition at line 50 of file IOdictionaryIO.C.

References regIOobject::write().

void operator= ( const IOdictionary &   rhs  )

Assignment of other IOdictionary's entries to this IOdictionary.

Definition at line 98 of file IOdictionary.C.

References dictionary::operator=().

Referenced by IOdictionary::IOdictionary().


The documentation for this class was generated from the following files: