General purpose template dictionary class that manages the storage associated with it. More...

Inheritance diagram for Dictionary< T >:

Collaboration diagram for Dictionary< T >:

Public Member Functions
	Dictionary (const label size=128)
	Construct with given or default (128) table capacity. More...

	Dictionary (const Dictionary &dict)
	Copy construct. More...

bool	erase (const word &keyword)
	Remove an entry specified by keyword and delete the pointer. More...

Public Member Functions inherited from DictionaryBase< IDLList< 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< IDLList< 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< IDLList< T >, T >
void	addEntries ()

Protected Attributes inherited from DictionaryBase< IDLList< T >, T >
HashTable< T * >	hashedTs_
	HashTable of the entries held on the IDLListType for quick lookup. More...

Detailed Description

template<class T>
class Foam::Dictionary< T >

General purpose template dictionary class that manages the storage associated with it.

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

Source files

Definition at line 57 of file Dictionary.H.

Constructor & Destructor Documentation

◆ Dictionary() [1/2]

Dictionary ( const label size = 128 )

explicit

Construct with given or default (128) table capacity.

Definition at line 34 of file Dictionary.C.

◆ Dictionary() [2/2]

Dictionary ( const Dictionary< T > & dict )

Copy construct.

Definition at line 41 of file Dictionary.C.

Member Function Documentation

◆ erase()

bool erase ( const word & keyword )

Remove an entry specified by keyword and delete the pointer.

Returns: true if the keyword was found

Definition at line 50 of file Dictionary.C.

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

src/OpenFOAM/containers/Dictionaries/Dictionary/Dictionary.H
src/OpenFOAM/containers/Dictionaries/Dictionary/Dictionary.C

Public Member Functions

Additional Inherited Members