Base dictionary class templated on both the form of doubly-linked list it uses as well as the type it holds. More...
Public Member Functions | |
DictionaryBase (const label size=128) | |
Construct given initial table size. More... | |
DictionaryBase (const DictionaryBase &) | |
Copy constructor. More... | |
DictionaryBase (DictionaryBase &&) | |
Move constructor. 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 T * | lookupPtr (const word &) const |
Find and return an entry if present, otherwise return nullptr. More... | |
T * | lookupPtr (const word &) |
Find and return an entry if present, otherwise return nullptr. More... | |
const T * | lookup (const word &) const |
Find and return entry. More... | |
T * | lookup (const word &) |
Find and return entry. More... | |
wordList | toc () const |
Return the table of contents. More... | |
wordList | sortedToc () const |
Return the table of contents as a sorted list. More... | |
void | insert (const word &, T *) |
Add at head of dictionary. More... | |
void | append (const word &, T *) |
Add at tail of dictionary. More... | |
T * | remove (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 T * | operator[] (const word &key) const |
Find and return entry. More... | |
T * | operator[] (const word &key) |
Find and return entry. More... | |
Protected Member Functions | |
void | addEntries () |
Protected Attributes | |
HashTable< T * > | hashedTs_ |
HashTable of the entries held on the IDLListType for quick lookup. More... | |
Friends | |
Ostream & | operator (Ostream &, const 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.
Definition at line 61 of file DictionaryBase.H.
DictionaryBase | ( | const label | size = 128 | ) |
Construct given initial table size.
Definition at line 48 of file DictionaryBase.C.
Referenced by DictionaryBase< DLPtrList< T >, T >::DictionaryBase().
DictionaryBase | ( | const DictionaryBase< IDLListType, T > & | dict | ) |
Copy constructor.
Definition at line 56 of file DictionaryBase.C.
DictionaryBase | ( | DictionaryBase< IDLListType, T > && | dict | ) |
Move constructor.
Definition at line 68 of file DictionaryBase.C.
DictionaryBase | ( | Istream & | is, |
const INew & | iNew | ||
) |
Construct from Istream using given Istream constructor class.
Definition at line 80 of file DictionaryBase.C.
DictionaryBase | ( | Istream & | is | ) |
Construct from Istream using default Istream constructor class.
Definition at line 92 of file DictionaryBase.C.
|
protected |
Definition at line 31 of file DictionaryBase.C.
bool found | ( | const word & | keyword | ) | const |
Search DictionaryBase for given keyword.
Definition at line 103 of file DictionaryBase.C.
Find and return an entry if present, otherwise return nullptr.
Definition at line 111 of file DictionaryBase.C.
Referenced by Foam::debug::addDebugObject(), Foam::debug::addDimensionedConstantObject(), Foam::debug::addDimensionSetObject(), Foam::debug::addInfoObject(), Foam::debug::addOptimisationObject(), DictionaryBase< DLPtrList< T >, T >::found(), and Time::readDict().
Find and return an entry if present, otherwise return nullptr.
Definition at line 129 of file DictionaryBase.C.
Find and return entry.
Definition at line 145 of file DictionaryBase.C.
Referenced by DictionaryBase< DLPtrList< T >, T >::operator[]().
Find and return entry.
Definition at line 161 of file DictionaryBase.C.
Foam::wordList toc | ( | ) | const |
Return the table of contents.
Definition at line 177 of file DictionaryBase.C.
Foam::wordList sortedToc | ( | ) | const |
Return the table of contents as a sorted list.
Definition at line 197 of file DictionaryBase.C.
Add at head of dictionary.
Definition at line 204 of file DictionaryBase.C.
Add at tail of dictionary.
Definition at line 213 of file DictionaryBase.C.
Referenced by Foam::debug::addDebugObject(), Foam::debug::addDimensionedConstantObject(), Foam::debug::addDimensionSetObject(), Foam::debug::addInfoObject(), and Foam::debug::addOptimisationObject().
Remove and return entry specified by keyword.
Return nullptr if the keyword was not found.
Definition at line 222 of file DictionaryBase.C.
void clear | ( | ) |
Clear the dictionary.
Definition at line 240 of file DictionaryBase.C.
void transfer | ( | DictionaryBase< IDLListType, T > & | dict | ) |
Transfer the contents of the argument into this DictionaryBase.
and annul the argument.
Definition at line 249 of file DictionaryBase.C.
Referenced by DictionaryBase< DLPtrList< T >, T >::clear().
void operator= | ( | const DictionaryBase< IDLListType, T > & | ) |
Definition at line 262 of file DictionaryBase.C.
Find and return entry.
Definition at line 162 of file DictionaryBase.H.
Find and return entry.
Definition at line 168 of file DictionaryBase.H.
|
friend |
HashTable of the entries held on the IDLListType for quick lookup.
Definition at line 81 of file DictionaryBase.H.
Referenced by DictionaryBase< DLPtrList< T >, T >::transfer().