UDictionary< T > Class Template Reference

Template dictionary class which does not manages the storage associated with it. More...

Inheritance diagram for UDictionary< T >:
[legend]
Collaboration diagram for UDictionary< T >:
[legend]

Public Member Functions

 UDictionary ()
 Null constructor. More...
 
 UDictionary (const UDictionary &)
 Copy construct. More...
 
- Public Member Functions inherited from DictionaryBase< UIDLList< 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 Tcfind (const word &keyword) const
 Find and return an entry, nullptr on failure. More...
 
Tfind (const word &keyword)
 Find and return an entry, nullptr on failure. More...
 
const Tlookup (const word &keyword) const
 Find and return entry, FatalError on failure. More...
 
Tlookup (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...
 
Tremove (const word &keyword)
 Remove and return entry specified by keyword. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (DictionaryBase< UIDLList< T >, T > &dict)
 Transfer the contents of the argument into this DictionaryBase. More...
 
void operator= (const DictionaryBase &)
 Copy assignment. More...
 
const Toperator[] (const word &key) const
 Find and return entry. More...
 
Toperator[] (const word &key)
 Find and return entry. More...
 
const TlookupPtr (const word &keyword) const
 Deprecated(2020-03) use cfind() More...
 
TlookupPtr (const word &keyword)
 Deprecated(2020-03) use find() More...
 

Additional Inherited Members

- Protected Member Functions inherited from DictionaryBase< UIDLList< T >, T >
void addEntries ()
 
- Protected Attributes inherited from DictionaryBase< UIDLList< T >, T >
HashTable< T * > hashedTs_
 HashTable of the entries held on the IDLListType for quick lookup. More...
 

Detailed Description

template<class T>
class Foam::UDictionary< T >

Template dictionary class which does not manages the storage associated with it.

It is derived from DictionaryBase instantiated on a non-memory managed form of intrusive doubly-linked list of <T>.

Source files

Definition at line 56 of file UDictionary.H.

Constructor & Destructor Documentation

◆ UDictionary() [1/2]

Null constructor.

Definition at line 33 of file UDictionary.C.

◆ UDictionary() [2/2]

UDictionary ( const UDictionary< T > &  dict)

Copy construct.

Definition at line 38 of file UDictionary.C.


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