DictionaryBase Class Reference

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:

Collaboration diagram for DictionaryBase:

Public Member Functions
	DictionaryBase (const label size=128)
	Construct given initial table size. More...
	DictionaryBase (const DictionaryBase &)
	Copy construct. More...
template<class INew >
	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...

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

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

• DictionaryBase.H
• DictionaryBase.C
• DictionaryBaseIO.C

Definition at line 61 of file DictionaryBase.H.

Constructor & Destructor Documentation

DictionaryBase() [1/4]

DictionaryBase

(

const label

size = 128

)

Construct given initial table size.

DictionaryBase() [2/4]

DictionaryBase

(

const DictionaryBase &

)

Copy construct.

DictionaryBase() [3/4]

DictionaryBase	(	Istream &	is,
		const INew &	iNew
	)

Construct from Istream using given Istream constructor class.

Definition at line 69 of file DictionaryBase.C.

DictionaryBase() [4/4]

DictionaryBase

(

Istream &

)

Construct from Istream using default Istream constructor class.

Member Function Documentation

addEntries()

void addEntries ( )

protected

Definition at line 31 of file DictionaryBase.C.

found()

bool found

(

const word &

keyword

)

const

Search DictionaryBase for given keyword.

Definition at line 93 of file DictionaryBase.C.

lookupPtr() [1/2]

const T* lookupPtr

(

const word &

)

const

Find and return an entry if present, otherwise return NULL.

Referenced by Foam::debug::addDebugObject(), Foam::debug::addDimensionedConstantObject(), Foam::debug::addDimensionSetObject(), Foam::debug::addInfoObject(), Foam::debug::addOptimisationObject(), and Time::readDict().

Here is the caller graph for this function:

lookupPtr() [2/2]

T* lookupPtr

(

const word &

)

Find and return an entry if present, otherwise return NULL.

lookup() [1/2]

const T* lookup

(

const word &

)

const

Find and return entry.

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

Here is the caller graph for this function:

lookup() [2/2]

T* lookup

(

const word &

)

Find and return entry.

toc()

Foam::wordList toc

(

)

const

Return the table of contents.

Definition at line 172 of file DictionaryBase.C.

insert()

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

Add at head of dictionary.

Definition at line 193 of file DictionaryBase.C.

append()

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

Add at tail of dictionary.

Definition at line 203 of file DictionaryBase.C.

Referenced by Foam::debug::addDebugObject(), Foam::debug::addDimensionedConstantObject(), Foam::debug::addDimensionSetObject(), Foam::debug::addInfoObject(), and Foam::debug::addOptimisationObject().

Here is the caller graph for this function:

remove()

T * remove

(

const word &

keyword

)

Remove and return entry specified by keyword.

Return NULL if the keyword was not found.

Definition at line 212 of file DictionaryBase.C.

clear()

void clear

(

)

Clear the dictionary.

Definition at line 230 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 239 of file DictionaryBase.C.

operator=()

void operator=

(

const DictionaryBase &

)

Definition at line 252 of file DictionaryBase.C.

operator[]() [1/2]

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

inline

Find and return entry.

Definition at line 156 of file DictionaryBase.H.

operator[]() [2/2]

T* operator[] ( const word &  key )

inline

Find and return entry.

Definition at line 162 of file DictionaryBase.H.

Friends And Related Function Documentation

operator

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

friend

Field Documentation

hashedTs_

HashTable<T*> hashedTs_

protected

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

Definition at line 81 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