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

Inheritance diagram for PtrDictionary< T >:

Collaboration diagram for PtrDictionary< T >:

Public Member Functions
	PtrDictionary (const label size=128)
	Construct given initial table size. More...

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

template<class INew >
	PtrDictionary (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

	PtrDictionary (Istream &is)
	Construct from Istream. 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< DLPtrList< 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< DLPtrList< 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< DLPtrList< T >, T >
void	addEntries ()

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

Detailed Description

template<class T>
class Foam::PtrDictionary< T >

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 55 of file PtrDictionary.H.

Constructor & Destructor Documentation

◆ PtrDictionary() [1/4]

PtrDictionary ( const label size = 128 )

Construct given initial table size.

Definition at line 33 of file PtrDictionary.C.

◆ PtrDictionary() [2/4]

PtrDictionary ( const PtrDictionary< T > & dict )

Copy construct.

Definition at line 40 of file PtrDictionary.C.

◆ PtrDictionary() [3/4]

PtrDictionary	(	Istream &	is,
		const INew &	inew
	)

Construct from Istream using given Istream constructor class.

Definition at line 48 of file PtrDictionary.C.

◆ PtrDictionary() [4/4]

PtrDictionary ( Istream & is )

Construct from Istream.

Definition at line 55 of file PtrDictionary.C.

Member Function Documentation

◆ operator[]() [1/2]

const T& operator[] ( const word & key ) const

inline

Find and return entry.

Definition at line 81 of file PtrDictionary.H.

◆ operator[]() [2/2]

T& operator[] ( const word & key )