OpenFOAM logo
Open Source CFD Toolkit

objectRegistry Class Reference

Inheritance diagram for objectRegistry:

Inheritance graph
[legend]
Collaboration diagram for objectRegistry:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TypeName ("objectRegistry")
 Declare type name for this IOobject.
 objectRegistry (const Time &db, const label nIoObjects=100)
 Construct the time objectRegistry given an initial estimate.
 objectRegistry (const IOobject &io, const label nIoObjects=100)
 Construct a sub-registry given an IObject to describe the registry.
virtual ~objectRegistry ()
const Timetime () const
 Return time.
const objectRegistryparent () const
 Return the parent objectRegistry.
virtual const fileNamedbDir () const
 Local directory path of this objectRegistry relative to the time.
wordList names () const
 Return the list of names of the IOobjects.
wordList names (const word &className) const
 Return the list of names of the IOobjects of given class.
const objectRegistrysubRegistry (const word &name) const
 Lookup and return a const sub-objectRegistry.
template<class Type>
HashTable< const Type * > lookupClass () const
 Lookup and return all the object of the given Type.
template<class Type>
bool foundObject (const word &name) const
 Is the named Type.
template<class Type>
const Type & lookupObject (const word &name) const
 Lookup and return the object of the given Type.
bool checkIn (regIOobject &) const
 Add an regIOobject to registry.
bool checkOut (regIOobject &) const
 Remove an regIOobject from registry.
void readModifiedObjects ()
 Read the objects that have been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool writeData (Ostream &) const
 writeData function required by regIOobject but not used
virtual bool write (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
 Write the objects.
bool write () const
 Write using setting from DB.

Constructor & Destructor Documentation

objectRegistry const Time db,
const label  nIoObjects = 100
[explicit]
 

Construct the time objectRegistry given an initial estimate.

for the number of entries

objectRegistry const IOobject io,
const label  nIoObjects = 100
[explicit]
 

Construct a sub-registry given an IObject to describe the registry.

and an initial estimate for the number of entries

virtual ~objectRegistry  )  [virtual]
 


Member Function Documentation

bool checkIn regIOobject  )  const
 

Add an regIOobject to registry.

bool checkOut regIOobject  )  const
 

Remove an regIOobject from registry.

virtual const fileName& dbDir  )  const [inline, virtual]
 

Local directory path of this objectRegistry relative to the time.

Reimplemented in Time, and polyMesh.

Definition at line 137 of file objectRegistry.H.

References notImplemented.

bool foundObject const word name  )  const
 

Is the named Type.

HashTable<const Type*> lookupClass  )  const
 

Lookup and return all the object of the given Type.

const Type& lookupObject const word name  )  const
 

Lookup and return the object of the given Type.

wordList names const word className  )  const
 

Return the list of names of the IOobjects of given class.

wordList names  )  const
 

Return the list of names of the IOobjects.

const objectRegistry& parent  )  const [inline]
 

Return the parent objectRegistry.

Definition at line 131 of file objectRegistry.H.

References Foam::wordList.

virtual bool readIfModified  )  [virtual]
 

Read object if modified.

Reimplemented from regIOobject.

void readModifiedObjects  ) 
 

Read the objects that have been modified.

Reimplemented in Time.

const objectRegistry& subRegistry const word name  )  const
 

Lookup and return a const sub-objectRegistry.

const Time& time  )  const [inline]
 

Return time.

Reimplemented from IOobject.

Reimplemented in fvMesh.

Definition at line 125 of file objectRegistry.H.

TypeName "objectRegistry"   ) 
 

Declare type name for this IOobject.

bool write  )  const [inline]
 

Write using setting from DB.

Reimplemented from regIOobject.

Reimplemented in Time, and fvMesh.

Definition at line 208 of file objectRegistry.H.

virtual bool write IOstream::streamFormat  fmt,
IOstream::versionNumber  ver,
IOstream::compressionType  cmp
const [virtual]
 

Write the objects.

Reimplemented from regIOobject.

Reimplemented in Time, and fvMesh.

virtual bool writeData Ostream  )  const [inline, virtual]
 

writeData function required by regIOobject but not used

for this class, write is used instead

Implements regIOobject.

Definition at line 188 of file objectRegistry.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org