Template dictionary class which manages the storage associated with it. More...
Public Member Functions | |
PtrListDictionary (const label size) | |
Construct given initial list size. More... | |
PtrListDictionary (const PtrListDictionary &dict) | |
Copy construct. More... | |
template<class INew > | |
PtrListDictionary (Istream &is, const INew &inew) | |
Construct from Istream using given Istream constructor class. More... | |
PtrListDictionary (Istream &is) | |
Construct from Istream. More... | |
autoPtr< T > | set (const label, const word &key, T *) |
Set element to pointer provided and return old element. More... | |
autoPtr< T > | set (const label, const word &key, autoPtr< T > &) |
Set element to autoPtr value provided and return old element. More... | |
autoPtr< T > | set (const label, const word &key, tmp< T > &) |
Set element to tmp value provided and return old element. More... | |
const T & | operator[] (const word &key) const |
Find and return entry. More... | |
T & | operator[] (const word &key) |
Find and return entry. More... | |
Public Member Functions inherited from DictionaryBase< PtrList< T >, T > | |
DictionaryBase (const label size=128) | |
Construct with given or default (128) table capacity. More... | |
DictionaryBase (const DictionaryBase &dict) | |
Copy construct. More... | |
DictionaryBase (Istream &is, const INew &inew) | |
Construct from Istream using given Istream constructor class. More... | |
DictionaryBase (Istream &is) | |
Construct from Istream using default Istream constructor class. More... | |
bool | found (const word &keyword) const |
Search for given keyword. More... | |
const T * | cfind (const word &keyword) const |
Find and return an entry, nullptr on failure. More... | |
T * | find (const word &keyword) |
Find and return an entry, nullptr on failure. More... | |
const T * | lookup (const word &keyword) const |
Find and return entry, FatalError on failure. More... | |
T * | lookup (const word &keyword) |
Find and return entry, FatalError on failure. More... | |
wordList | toc () const |
Return the table of contents (as a sorted list) More... | |
wordList | sortedToc () const |
Return the table of contents as a sorted list. More... | |
wordList | sortedToc (const Compare &comp) const |
Return table of contents sorted using the specified comparator. More... | |
Foam::wordList | sortedToc (const Compare &comp) const |
void | insert (const word &keyword, T *) |
Add at head of dictionary. More... | |
void | append (const word &keyword, T *) |
Add at tail of dictionary. More... | |
T * | remove (const word &keyword) |
Remove and return entry specified by keyword. More... | |
void | clear () |
Clear the dictionary. More... | |
void | transfer (DictionaryBase< PtrList< T >, T > &dict) |
Transfer the contents of the argument into this DictionaryBase. More... | |
void | operator= (const DictionaryBase &) |
Copy assignment. More... | |
const T * | operator[] (const word &key) const |
Find and return entry. More... | |
T * | operator[] (const word &key) |
Find and return entry. More... | |
const T * | lookupPtr (const word &keyword) const |
Deprecated(2020-03) use cfind() More... | |
T * | lookupPtr (const word &keyword) |
Deprecated(2020-03) use find() More... | |
Additional Inherited Members | |
Protected Member Functions inherited from DictionaryBase< PtrList< T >, T > | |
void | addEntries () |
Protected Attributes inherited from DictionaryBase< PtrList< T >, T > | |
HashTable< T * > | hashedTs_ |
HashTable of the entries held on the IDLListType for quick lookup. More... | |
Template dictionary class which manages the storage associated with it.
It is derived from DictionaryBase instantiated on the memory managed PtrList of <T> to provide ordered indexing in addition to the dictionary lookup.
Definition at line 55 of file PtrListDictionary.H.
PtrListDictionary | ( | const label | size | ) |
Construct given initial list size.
Definition at line 33 of file PtrListDictionary.C.
PtrListDictionary | ( | const PtrListDictionary< T > & | dict | ) |
Copy construct.
Definition at line 42 of file PtrListDictionary.C.
PtrListDictionary | ( | Istream & | is, |
const INew & | inew | ||
) |
Construct from Istream using given Istream constructor class.
Definition at line 50 of file PtrListDictionary.C.
PtrListDictionary | ( | Istream & | is | ) |
Construct from Istream.
Definition at line 57 of file PtrListDictionary.C.
|
inline |
Set element to pointer provided and return old element.
Definition at line 67 of file PtrListDictionary.C.
|
inline |
Set element to autoPtr value provided and return old element.
Definition at line 85 of file PtrListDictionary.C.
|
inline |
Set element to tmp value provided and return old element.
Definition at line 104 of file PtrListDictionary.C.
Find and return entry.
Definition at line 95 of file PtrListDictionary.H.
Find and return entry.
Definition at line 101 of file PtrListDictionary.H.