Base dictionary class templated on both the form of doubly-linked list it uses as well as the type it holds. More...

Inheritance diagram for DictionaryBase< IDLListType, T >:

[legend]

Collaboration diagram for DictionaryBase< IDLListType, T >:

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

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

template<class INew >
	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...

template<class Compare >
wordList	sortedToc (const Compare &comp) const
	Return table of contents sorted using the specified comparator. More...

void	push_front (const word &keyword, T *ptr)
	Add to front of dictionary. More...

void	push_back (const word &keyword, T *ptr)
	Add to back 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< IDLListType, 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...

void	insert (const word &keyword, T *ptr)
	Add to front of dictionary. More...

void	prepend (const word &keyword, T *ptr)
	Add to front of dictionary. More...

void	append (const word &keyword, T *ptr)
	Add to back of dictionary. More...

template<class Compare >
Foam::wordList	sortedToc (const Compare &comp) const

Protected Member Functions
void	addEntries ()

Protected Attributes
HashTable< T * >	hashedTs_
	HashTable of the entries held on the IDLListType for quick lookup. More...

Friends
Ostream &	operator (Ostream &, const DictionaryBase< IDLListType, T > &)

Detailed Description

template<class IDLListType, class T>
class Foam::DictionaryBase< IDLListType, T >

Base dictionary class templated on both the form of doubly-linked list it uses as well as the type it holds.

The double templating allows for the instantiation of forms with or without storage management.

Note: The IDLListType parameter should itself be a template but this confused gcc 2.95.2 so it has to be instantiated for T when an instantiation of DictionaryBase is requested

See also: Dictionary and UDictionary

Source files

Definition at line 60 of file DictionaryBase.H.

Constructor & Destructor Documentation

◆ DictionaryBase() [1/4]

DictionaryBase ( const label size = 128 )

explicit

Construct with given or default (128) table capacity.

Definition at line 39 of file DictionaryBase.C.

◆ DictionaryBase() [2/4]

DictionaryBase ( const DictionaryBase< IDLListType, T > & dict )

Copy construct.

Definition at line 47 of file DictionaryBase.C.

◆ DictionaryBase() [3/4]

DictionaryBase	(	Istream &	is,
		const INew &	inew
	)

Construct from Istream using given Istream constructor class.

Definition at line 60 of file DictionaryBase.C.

◆ DictionaryBase() [4/4]

DictionaryBase ( Istream & is )

Construct from Istream using default Istream constructor class.

Definition at line 72 of file DictionaryBase.C.

Member Function Documentation

◆ addEntries()

void addEntries ( )

protected

Definition at line 27 of file DictionaryBase.C.

◆ found()

bool found ( const word & keyword ) const

Search for given keyword.

Definition at line 83 of file DictionaryBase.C.

◆ cfind()

const T * cfind ( const word & keyword ) const

Find and return an entry, nullptr on failure.

Definition at line 91 of file DictionaryBase.C.

Referenced by DictionaryBase< DLPtrList< T >, T >::lookupPtr().

Here is the caller graph for this function:

◆ find()

T * find ( const word & keyword )

Find and return an entry, nullptr on failure.

Definition at line 107 of file DictionaryBase.C.

Referenced by Foam::appendNamedEntry(), DictionaryBase< DLPtrList< T >, T >::lookupPtr(), and Time::readDict().

Here is the caller graph for this function:

◆ lookup() [1/2]

const T * lookup ( const word & keyword ) const

Find and return entry, FatalError on failure.

Definition at line 121 of file DictionaryBase.C.

Referenced by DictionaryBase< DLPtrList< T >, T >::operator[]().

Here is the caller graph for this function:

◆ lookup() [2/2]

T * lookup ( const word & keyword )

Find and return entry, FatalError on failure.

Definition at line 137 of file DictionaryBase.C.

◆ toc()

Foam::wordList toc ( ) const

Return the table of contents (as a sorted list)

Definition at line 153 of file DictionaryBase.C.

◆ sortedToc() [1/3]

Foam::wordList sortedToc ( ) const

Return the table of contents as a sorted list.

Definition at line 163 of file DictionaryBase.C.

◆ sortedToc() [2/3]

wordList sortedToc ( const Compare & comp ) const

Return table of contents sorted using the specified comparator.

◆ push_front()

void push_front	(	const word &	keyword,
		T *	ptr
	)

Add to front of dictionary.

Definition at line 182 of file DictionaryBase.C.

Referenced by DictionaryBase< DLPtrList< T >, T >::insert(), and DictionaryBase< DLPtrList< T >, T >::prepend().

Here is the caller graph for this function:

◆ push_back()

void push_back	(	const word &	keyword,
		T *	ptr
	)

Add to back of dictionary.

Definition at line 195 of file DictionaryBase.C.

Referenced by DictionaryBase< DLPtrList< T >, T >::append().

Here is the caller graph for this function:

◆ remove()

T * remove ( const word & keyword )

Remove and return entry specified by keyword.

Return nullptr if the keyword was not found.

Definition at line 207 of file DictionaryBase.C.

◆ clear()

void clear ( )

Clear the dictionary.

Definition at line 223 of file DictionaryBase.C.

◆ transfer()

void transfer ( DictionaryBase< IDLListType, T > & dict )

Transfer the contents of the argument into this DictionaryBase.

and annul the argument.

Definition at line 232 of file DictionaryBase.C.

◆ operator=()

void operator= ( const DictionaryBase< IDLListType, T > & )

Copy assignment.

Definition at line 250 of file DictionaryBase.C.

◆ operator[]() [1/2]

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

inline

Find and return entry.

Definition at line 205 of file DictionaryBase.H.

◆ operator[]() [2/2]

T* operator[] ( const word & key )

inline

Find and return entry.

Definition at line 213 of file DictionaryBase.H.

◆ lookupPtr() [1/2]

const T* lookupPtr ( const word & keyword ) const

inline

Deprecated(2020-03) use cfind()

Deprecated:: (2020-03) - use cfind() method

Definition at line 236 of file DictionaryBase.H.

◆ lookupPtr() [2/2]

T* lookupPtr ( const word & keyword )

inline

Deprecated(2020-03) use find()

Deprecated:: (2020-03) - use find() method

Definition at line 247 of file DictionaryBase.H.

◆ insert()

void insert	(	const word &	keyword,
		T *	ptr
	)

inline

Add to front of dictionary.

FOAM_DEPRECATED_FOR(2022-10, "push_front()")

Definition at line 257 of file DictionaryBase.H.

◆ prepend()

void prepend	(	const word &	keyword,
		T *	ptr
	)

inline

Add to front of dictionary.

FOAM_DEPRECATED_FOR(2022-10, "push_front()")

Definition at line 267 of file DictionaryBase.H.

◆ append()

void append	(	const word &	keyword,
		T *	ptr
	)

inline

Add to back of dictionary.

FOAM_DEPRECATED_FOR(2022-10, "push_back()")

Definition at line 277 of file DictionaryBase.H.

Referenced by Foam::appendNamedEntry().

Here is the caller graph for this function:

◆ sortedToc() [3/3]

Foam::wordList sortedToc ( const Compare & comp ) const

Definition at line 172 of file DictionaryBase.C.

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	,
		const DictionaryBase< IDLListType, T > &
	)

friend

Member Data Documentation

◆ hashedTs_

HashTable<T*> hashedTs_

protected

HashTable of the entries held on the IDLListType for quick lookup.

Definition at line 82 of file DictionaryBase.H.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<class IDLListType, class T> class Foam::DictionaryBase< IDLListType, T >

Constructor & Destructor Documentation

◆ DictionaryBase() [1/4]

◆ DictionaryBase() [2/4]

◆ DictionaryBase() [3/4]

◆ DictionaryBase() [4/4]

Member Function Documentation

◆ addEntries()

◆ found()

◆ cfind()

◆ find()

◆ lookup() [1/2]

◆ lookup() [2/2]

◆ toc()

◆ sortedToc() [1/3]

◆ sortedToc() [2/3]

◆ push_front()

◆ push_back()

◆ remove()

◆ clear()

◆ transfer()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ lookupPtr() [1/2]

◆ lookupPtr() [2/2]

◆ insert()

◆ prepend()

◆ append()

◆ sortedToc() [3/3]

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ hashedTs_

template<class IDLListType, class T>
class Foam::DictionaryBase< IDLListType, T >