Public Member Functions | List of all members
IOobjectList Class Reference

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

Inheritance diagram for IOobjectList:
Inheritance graph
[legend]
Collaboration diagram for IOobjectList:
Collaboration graph
[legend]

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...
 
IOobjectlookup (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< IOobject, word, string::hash > &)
 Construct as copy. More...
 
 ~HashPtrTable ()
 Destructor. More...
 
IOobjectremove (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< IOobject, word, string::hash > &)
 
- Public Member Functions inherited from HashTable< T, Key, Hash >
 HashTable (const label size=128)
 Construct given initial table size. More...
 
 HashTable (Istream &, const label size=128)
 Construct from Istream. More...
 
 HashTable (const HashTable< T, Key, Hash > &)
 Construct as copy. More...
 
 HashTable (const Xfer< HashTable< T, Key, Hash > > &)
 Construct by transferring the parameter contents. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const
 The size of the underlying table. More...
 
label size () const
 Return number of elements in table. More...
 
bool empty () const
 Return true if the hash table is empty. More...
 
bool found (const Key &) const
 Return true if hashedEntry is found in table. More...
 
iterator find (const Key &)
 Find and return an iterator set at the hashedEntry. More...
 
const_iterator find (const Key &) const
 Find and return an const_iterator set at the hashedEntry. More...
 
List< Key > toc () const
 Return the table of contents. More...
 
List< Key > sortedToc () const
 Return the table of contents as a sorted list. More...
 
OstreamprintInfo (Ostream &) const
 Print information. More...
 
bool insert (const Key &, const T &newElmt)
 Insert a new hashedEntry. More...
 
bool set (const Key &, const T &newElmt)
 Assign a new hashedEntry, overwriting existing entries. More...
 
bool erase (const iterator &)
 Erase a hashedEntry specified by given iterator. More...
 
bool erase (const Key &)
 Erase a hashedEntry specified by the given key. More...
 
label erase (const UList< Key > &)
 Remove entries given by the listed keys from this HashTable. More...
 
template<class AnyType , class AnyHash >
label erase (const HashTable< AnyType, Key, AnyHash > &)
 Remove entries given by the given keys from this HashTable. More...
 
void resize (const label newSize)
 Resize the hash table for efficiency. More...
 
void clear ()
 Clear all entries from table. More...
 
void clearStorage ()
 Clear the table entries and the table itself. More...
 
void shrink ()
 Shrink the allocated table to approx. twice number of elements. More...
 
void transfer (HashTable< T, Key, Hash > &)
 Transfer the contents of the argument table into this table. More...
 
Xfer< HashTable< T, Key, Hash > > xfer ()
 Transfer contents to the Xfer container. More...
 
Toperator[] (const Key &)
 Find and return a hashedEntry. More...
 
const Toperator[] (const Key &) const
 Find and return a hashedEntry. More...
 
Toperator() (const Key &)
 Find and return a hashedEntry, create it null if not present. More...
 
void operator= (const HashTable< T, Key, Hash > &)
 Assignment. More...
 
bool operator== (const HashTable< T, Key, Hash > &) const
 Equality. Hash tables are equal if the keys and values are equal. More...
 
bool operator!= (const HashTable< T, Key, Hash > &) const
 The opposite of the equality operation. Takes linear time. More...
 
iterator begin ()
 Iterator set to the beginning of the HashTable. More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable More...
 
const_iterator begin () const
 const_iterator set to the beginning of the HashTable More...
 
template<class AnyType , class AnyHash >
Foam::label erase (const HashTable< AnyType, Key, AnyHash > &rhs)
 
- Public Member Functions inherited from HashTableCore
 HashTableCore ()
 Construct null. More...
 
 ClassName ("HashTable")
 Define template name and debug. More...
 

Additional Inherited Members

- Public Types inherited from HashPtrTable< IOobject >
typedef HashTable< IOobject *, word, string::hash >::iterator iterator
 
typedef HashTable< IOobject *, word, string::hash >::const_iterator const_iterator
 
- Public Types inherited from HashTable< T, Key, Hash >
typedef T value_type
 Type of values the HashTable contains. More...
 
typedef Treference
 Type that can be used for storing into HashTable::value_type. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a HashTable. More...
 
- Static Public Member Functions inherited from HashTableCore
static label canonicalSize (const label)
 Return a canonical (power-of-two) size. More...
 
static iteratorEnd cend ()
 iteratorEnd set to beyond the end of any HashTable More...
 
static iteratorEnd end ()
 iteratorEnd set to beyond the end of any HashTable More...
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable table size. More...
 

Detailed Description

List of IOobjects with searching and retrieving facilities.

Source files

Definition at line 50 of file IOobjectList.H.

Constructor & Destructor Documentation

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 ( const objectRegistry db,
const fileName instance,
const fileName local = "",
IOobject::readOption  r = IOobject::MUST_READ,
IOobject::writeOption  w = IOobject::NO_WRITE,
bool  registerObject = true 
)
IOobjectList ( const IOobjectList ioOL)

Construct as copy.

Definition at line 92 of file IOobjectList.C.

Destructor.

Definition at line 100 of file IOobjectList.C.

Member Function Documentation

bool add ( IOobject io)

Add an IOobject to the list.

Definition at line 106 of file IOobjectList.C.

References HashTable< T, Key, Hash >::insert(), and IOobject::name().

Here is the call graph for this function:

bool remove ( IOobject io)

Remove an IOobject from the list.

Definition at line 112 of file IOobjectList.C.

References HashTableCore::end(), HashPtrTable< IOobject >::erase(), HashTable< T *, Key, Hash >::find(), and IOobject::name().

Here is the call graph for this function:

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 HashTableCore::end(), Foam::endl(), HashTable< T, Key, Hash >::find(), and Foam::Info.

Here is the call graph for this function:

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, HashTable< T, Key, Hash >::insert(), wordRe::match(), Foam::name(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

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, HashTable< T, Key, Hash >::insert(), wordReListMatcher::match(), Foam::name(), IOobjectList::names(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

Foam::IOobjectList lookupClass ( const word className) const
Foam::wordList names ( ) const

Return the list of names of the IOobjects.

Definition at line 221 of file IOobjectList.C.

References HashTable< T *, Key, Hash >::toc().

Referenced by vtkPV3Foam::addToSelection(), vtkPV4Foam::addToSelection(), IOobjectList::lookup(), and IOobjectList::sortedNames().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::wordList sortedNames ( ) const

Return the sorted list of names of the IOobjects.

Definition at line 227 of file IOobjectList.C.

References HashTable< T *, Key, Hash >::sortedToc().

Here is the call graph for this function:

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 forAllConstIter(), List< T >::setSize(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

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 IOobjectList::names(), and Foam::sort().

Here is the call graph for this function:


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