IOobjectList Class Reference

List of IOobjects with searching and retrieving facilities. More...

Inheritance diagram for IOobjectList:

Collaboration diagram for IOobjectList:

Public Member Functions
	IOobjectList (const label nIoObjects=128)
	Construct given an initial estimate for the number of entries. More...
	IOobjectList (const objectRegistry &db, const fileName &instance, const fileName &local="", IOobject::readOption r=IOobject::MUST_READ, IOobject::writeOption w=IOobject::NO_WRITE, bool registerObject=true)
	Construct from objectRegistry and instance path. More...
	IOobjectList (const IOobjectList &)
	Construct as copy. More...
	~IOobjectList ()
	Destructor. More...
bool	add (IOobject &)
	Add an IOobject to the list. More...
bool	remove (IOobject &)
	Remove an IOobject from the list. More...
IOobject *	lookup (const word &name) const
	Lookup a given name and return IOobject ptr if found else NULL. More...
IOobjectList	lookup (const wordRe &name) const
	Return the list for all IOobects whose name matches name. More...
IOobjectList	lookup (const wordReList &patterns) const
	Return the list for all IOobects whose name matches name. More...
IOobjectList	lookupClass (const word &className) const
	Return the list for all IOobjects of a given class. More...
wordList	names () const
	Return the list of names of the IOobjects. More...
wordList	sortedNames () const
	Return the sorted list of names of the IOobjects. More...
wordList	names (const word &className) const
	Return the list of names of the IOobjects of given class. More...
wordList	sortedNames (const word &className) const
	Return the sorted list of names of the IOobjects of given class. More...
Public Member Functions inherited from HashPtrTable< IOobject >
	HashPtrTable (const label size=128)
	Construct given initial table size. More...
	HashPtrTable (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...
	HashPtrTable (Istream &)
	Construct from Istream using default Istream constructor class. More...
	HashPtrTable (const dictionary &)
	Construct from dictionary using default dictionary constructor. More...
	HashPtrTable (const HashPtrTable< T, Key, Hash > &)
	Construct as copy. More...
	~HashPtrTable ()
	Destructor. More...
T *	remove (iterator &)
	Remove and return the pointer specified by given iterator. More...
bool	erase (iterator &)
	Erase an hashedEntry specified by given iterator. More...
void	clear ()
	Clear all entries from table. More...
void	write (Ostream &os) const
	Write. More...
void	operator= (const HashPtrTable< T, Key, Hash > &)

Private Member Functions
void	operator= (const IOobjectList &)
	Disallow default bitwise assignment. More...

Additional Inherited Members
Public Types inherited from HashPtrTable< IOobject >
typedef HashTable< T *, Key, Hash >::iterator	iterator
typedef HashTable< T *, Key, Hash >::const_iterator	const_iterator

Detailed Description

List of IOobjects with searching and retrieving facilities.

Source files

• IOobjectList.H
• IOobjectList.C

Definition at line 50 of file IOobjectList.H.

Constructor & Destructor Documentation

IOobjectList() [1/3]

IOobjectList ( const label  nIoObjects = 128 )

explicit

Construct given an initial estimate for the number of entries.

Definition at line 33 of file IOobjectList.C.

IOobjectList() [2/3]

IOobjectList	(	const objectRegistry &	db,
		const fileName &	instance,
		const fileName &	local = "",
		IOobject::readOption	r = IOobject::MUST_READ,
		IOobject::writeOption	w = IOobject::NO_WRITE,
		bool	registerObject = true
	)

Construct from objectRegistry and instance path.

Definition at line 40 of file IOobjectList.C.

References objectRegistry::dbDir(), fileName::FILE, Time::findInstancePath(), forAll, IOobject::headerOk(), insert(), Foam::isDir(), IOobject::path(), Foam::readDir(), objectRegistry::time(), and w().

Here is the call graph for this function:

IOobjectList() [3/3]

IOobjectList

(

const IOobjectList &

ioOL

)

Construct as copy.

Definition at line 92 of file IOobjectList.C.

~IOobjectList()

~IOobjectList

(

)

Destructor.

Definition at line 100 of file IOobjectList.C.

Member Function Documentation

operator=()

void operator= ( const IOobjectList &  )

private

Disallow default bitwise assignment.

add()

bool add

(

IOobject &

io

)

Add an IOobject to the list.

Definition at line 106 of file IOobjectList.C.

References insert(), and IOobject::name().

Referenced by streamLineBase::initInterpolations().

Here is the call graph for this function:

Here is the caller graph for this function:

remove()

bool remove

(

IOobject &

io

)

Remove an IOobject from the list.

Definition at line 112 of file IOobjectList.C.

References erase(), and IOobject::name().

Here is the call graph for this function:

lookup() [1/3]

Foam::IOobject * lookup

(

const word &

name

)

const

Lookup a given name and return IOobject ptr if found else NULL.

Definition at line 128 of file IOobjectList.C.

References Foam::endl(), Foam::Info, and Foam::name().

Referenced by parLagrangianRedistributor::findClouds(), main(), polyMeshGenPoints::read(), polyMeshGenCells::read(), and polyMeshGenFaces::read().

Here is the call graph for this function:

Here is the caller graph for this function:

lookup() [2/3]

Foam::IOobjectList lookup

(

const wordRe &

name

)

const

Return the list for all IOobects whose name matches name.

Definition at line 155 of file IOobjectList.C.

References Foam::endl(), forAllConstIter(), Foam::Info, string::match(), and Foam::name().

Here is the call graph for this function:

lookup() [3/3]

Foam::IOobjectList lookup

(

const wordReList &

patterns

)

const

Return the list for all IOobects whose name matches name.

Definition at line 176 of file IOobjectList.C.

References Foam::endl(), forAllConstIter(), Foam::Info, wordReListMatcher::match(), and Foam::name().

Here is the call graph for this function:

lookupClass()

Foam::IOobjectList lookupClass

(

const word &

className

)

const

Return the list for all IOobjects of a given class.

Definition at line 199 of file IOobjectList.C.

References ClassName, Foam::endl(), forAllConstIter(), and Foam::Info.

Referenced by main(), Foam::MapConsistentVolFields(), Foam::MapLagrangianFields(), Foam::MapVolFields(), printAllSets(), lagrangianFieldDecomposer::readFieldFields(), Foam::readFields(), lagrangianFieldDecomposer::readFields(), readFields(), pointFieldReconstructor::reconstructFields(), parFvFieldReconstructor::reconstructFvSurfaceFields(), fvFieldReconstructor::reconstructFvSurfaceFields(), parFvFieldReconstructor::reconstructFvVolumeFields(), fvFieldReconstructor::reconstructFvVolumeFields(), parFvFieldReconstructor::reconstructFvVolumeInternalFields(), fvFieldReconstructor::reconstructFvVolumeInternalFields(), Foam::reconstructLagrangianFieldFields(), Foam::reconstructLagrangianFields(), sampledSurfaces::sampleAndWrite(), Foam::UnMapped(), setUpdater::updateSets(), polyMeshFilter::updateSets(), and domainDecomposition::writeDecomposition().

Here is the call graph for this function:

Here is the caller graph for this function:

names() [1/2]

Foam::wordList names

(

)

const

Return the list of names of the IOobjects.

Definition at line 221 of file IOobjectList.C.

Referenced by vtkPV3Foam::addToSelection(), vtkPV4Foam::addToSelection(), parLagrangianRedistributor::filterObjects(), main(), polyMeshGenPoints::read(), polyMeshGenCells::read(), polyMeshGenFaces::read(), redistributeAndWrite(), and sampledSurfaces::sampleAndWrite().

Here is the caller graph for this function:

sortedNames() [1/2]

Foam::wordList sortedNames

(

)

const

Return the sorted list of names of the IOobjects.

Definition at line 227 of file IOobjectList.C.

Referenced by sampledSurfaces::classifyFields(), probes::classifyFields(), sampledSets::classifyFields(), Foam::fieldNames(), Foam::readFields(), and readFields().

Here is the caller graph for this function:

names() [2/2]

Foam::wordList names

(

const word &

className

)

const

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

Definition at line 233 of file IOobjectList.C.

References ClassName, forAllConstIter(), and List::setSize().

Here is the call graph for this function:

sortedNames() [2/2]

Foam::wordList sortedNames

(

const word &

className

)

const

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

Definition at line 252 of file IOobjectList.C.

References ClassName, and Foam::sort().

Here is the call graph for this function:

---

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

• src/OpenFOAM/db/IOobjectList/IOobjectList.H
• src/OpenFOAM/db/IOobjectList/IOobjectList.C