DictionaryBase< IDLListType, T > Class Template Reference

Base dictionary class templated on both the form of doubly-linked list it uses as well as the type it holds. More...

Inheritance diagram for DictionaryBase< IDLListType, T >:
Collaboration diagram for DictionaryBase< IDLListType, T >:

Public Member Functions

 DictionaryBase (const label size=128)
 Construct given initial table size. More...
 
 DictionaryBase (const DictionaryBase &)
 Copy construct. More...
 
template<class INew >
 DictionaryBase (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 DictionaryBase (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
bool found (const word &) const
 Search DictionaryBase for given keyword. More...
 
const TlookupPtr (const word &) const
 Find and return an entry if present, otherwise return NULL. More...
 
TlookupPtr (const word &)
 Find and return an entry if present, otherwise return NULL. More...
 
const Tlookup (const word &) const
 Find and return entry. More...
 
Tlookup (const word &)
 Find and return entry. More...
 
wordList toc () const
 Return the table of contents. More...
 
void insert (const word &, T *)
 Add at head of dictionary. More...
 
void append (const word &, T *)
 Add at tail of dictionary. More...
 
Tremove (const word &)
 Remove and return entry specified by keyword. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (DictionaryBase< IDLListType, T > &)
 Transfer the contents of the argument into this DictionaryBase. More...
 
void operator= (const DictionaryBase &)
 
const Toperator[] (const word &key) const
 Find and return entry. More...
 
Toperator[] (const word &key)
 Find and return entry. More...
 

Friends

Ostreamoperator (Ostream &, const DictionaryBase< IDLListType, T > &)
 

Detailed Description

template<class IDLListType, class T>
class Foam::DictionaryBase< IDLListType, T >

Base dictionary class templated on both the form of doubly-linked list it uses as well as the type it holds.

The double templating allows for the instantiation of forms with or without storage management.

Note
The IDLListType parameter should itself be a template but this confused gcc 2.95.2 so it has to be instantiated for T when an instantiation of DictionaryBase is requested
See Also
Dictionary and UDictionary
Source files

Definition at line 62 of file DictionaryBase.H.

Constructor & Destructor Documentation

DictionaryBase ( const label  size = 128)

Construct given initial table size.

Definition at line 48 of file DictionaryBase.C.

DictionaryBase ( const DictionaryBase< IDLListType, T > &  dict)

Copy construct.

Definition at line 56 of file DictionaryBase.C.

DictionaryBase ( Istream is,
const INew iNew 
)

Construct from Istream using given Istream constructor class.

Definition at line 69 of file DictionaryBase.C.

Construct from Istream using default Istream constructor class.

Definition at line 81 of file DictionaryBase.C.

Member Function Documentation

bool found ( const word keyword) const

Search DictionaryBase for given keyword.

Definition at line 93 of file DictionaryBase.C.

const T * lookupPtr ( const word keyword) const

Find and return an entry if present, otherwise return NULL.

Definition at line 102 of file DictionaryBase.C.

References HashTableCore::end(), and HashTable< T, Key, Hash >::find().

Referenced by Foam::debug::addDebugObject(), Foam::debug::addDimensionedConstantObject(), Foam::debug::addDimensionSetObject(), Foam::debug::addInfoObject(), Foam::debug::addOptimisationObject(), and Time::readDict().

Here is the call graph for this function:

Here is the caller graph for this function:

T * lookupPtr ( const word keyword)

Find and return an entry if present, otherwise return NULL.

Definition at line 121 of file DictionaryBase.C.

References HashTableCore::end(), and HashTable< T, Key, Hash >::find().

Here is the call graph for this function:

const T * lookup ( const word keyword) const

Find and return entry.

Definition at line 138 of file DictionaryBase.C.

References HashTableCore::end(), Foam::exit(), Foam::FatalError, FatalErrorIn, and HashTable< T, Key, Hash >::find().

Referenced by DictionaryBase< DLPtrList< T >, T >::operator[]().

Here is the call graph for this function:

Here is the caller graph for this function:

T * lookup ( const word keyword)

Find and return entry.

Definition at line 157 of file DictionaryBase.C.

References HashTableCore::end(), Foam::exit(), Foam::FatalError, FatalErrorIn, and HashTable< T, Key, Hash >::find().

Here is the call graph for this function:

Foam::wordList toc ( ) const

Return the table of contents.

Definition at line 176 of file DictionaryBase.C.

void insert ( const word keyword,
T tPtr 
)

Add at head of dictionary.

Definition at line 197 of file DictionaryBase.C.

References insert().

Here is the call graph for this function:

void append ( const word keyword,
T tPtr 
)

Add at tail of dictionary.

Definition at line 207 of file DictionaryBase.C.

Referenced by Foam::debug::addDebugObject(), Foam::debug::addDimensionedConstantObject(), Foam::debug::addDimensionSetObject(), Foam::debug::addInfoObject(), and Foam::debug::addOptimisationObject().

Here is the caller graph for this function:

T * remove ( const word keyword)

Remove and return entry specified by keyword.

Return NULL if the keyword was not found.

Definition at line 216 of file DictionaryBase.C.

References HashTableCore::end(), HashTable< T, Key, Hash >::find(), and Foam::T().

Here is the call graph for this function:

void clear ( )

Clear the dictionary.

Definition at line 234 of file DictionaryBase.C.

References clear().

Here is the call graph for this function:

void transfer ( DictionaryBase< IDLListType, T > &  dict)

Transfer the contents of the argument into this DictionaryBase.

and annul the argument.

Definition at line 243 of file DictionaryBase.C.

void operator= ( const DictionaryBase< IDLListType, T > &  )

Definition at line 256 of file DictionaryBase.C.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

const T* operator[] ( const word key) const
inline

Find and return entry.

Definition at line 154 of file DictionaryBase.H.

T* operator[] ( const word key)
inline

Find and return entry.

Definition at line 160 of file DictionaryBase.H.

Friends And Related Function Documentation

Ostream& operator ( Ostream ,
const DictionaryBase< IDLListType, T > &   
)
friend

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