Gerneral purpose template dictionary class which 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 given initial table size. More...

	Dictionary (const Dictionary &)
	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 given initial table size. More...

	DictionaryBase (const DictionaryBase &)
	Copy construct. More...

	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 NULL. More...

T *	lookupPtr (const word &)
	Find and return an entry if present, otherwise return NULL. 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...

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...

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 >

Gerneral purpose template dictionary class which 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 54 of file Dictionary.H.

Constructor & Destructor Documentation

◆ Dictionary() [1/2]

Dictionary ( const label size = 128 )

Construct given initial table size.

Definition at line 31 of file Dictionary.C.

◆ Dictionary() [2/2]

Dictionary ( const Dictionary< T > & dict )

Copy construct.

Definition at line 38 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 47 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