PtrListDictionary< T > Class Template Reference

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

Inheritance diagram for PtrListDictionary< T >:

Collaboration diagram for PtrListDictionary< T >:

Public Member Functions
	PtrListDictionary (const label size)
	Construct given initial list size. More...
	PtrListDictionary (const PtrListDictionary &)
	Copy construct. More...
template<class INew >
	PtrListDictionary (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...
	PtrListDictionary (Istream &)
	Construct from Istream. More...
autoPtr< T >	set (const label, const word &key, T *)
	Set element to pointer provided and return old element. More...
autoPtr< T >	set (const label, const word &key, autoPtr< T > &)
	Set element to autoPtr value provided and return old element. More...
autoPtr< T >	set (const label, const word &key, tmp< T > &)
	Set element to tmp value provided and return old element. 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< PtrList< 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< PtrList< T >, T >
void	addEntries ()
Protected Attributes inherited from DictionaryBase< PtrList< T >, T >
HashTable< T * >	hashedTs_
	HashTable of the entries held on the IDLListType for quick lookup. More...

Detailed Description

template<class T>
class Foam::PtrListDictionary< T >

Template dictionary class which manages the storage associated with it.

It is derived from DictionaryBase instantiated on the memory managed PtrList of <T> to provide ordered indexing in addition to the dictionary lookup.

Source files

• PtrListDictionary.H
• PtrListDictionary.C

Definition at line 53 of file PtrListDictionary.H.

Constructor & Destructor Documentation

PtrListDictionary() [1/4]

PtrListDictionary

(

const label

size

)

Construct given initial list size.

Definition at line 31 of file PtrListDictionary.C.

PtrListDictionary() [2/4]

PtrListDictionary

(

const PtrListDictionary< T > &

dict

)

Copy construct.

Definition at line 40 of file PtrListDictionary.C.

PtrListDictionary() [3/4]

PtrListDictionary	(	Istream &	is,
		const INew &	iNew
	)

Construct from Istream using given Istream constructor class.

Definition at line 48 of file PtrListDictionary.C.

PtrListDictionary() [4/4]

PtrListDictionary

(

Istream &

is

)

Construct from Istream.

Definition at line 55 of file PtrListDictionary.C.

Member Function Documentation

set() [1/3]

Foam::autoPtr< T > set ( const label  i, const word &  key, T *  ptr  )

inline

Set element to pointer provided and return old element.

Definition at line 65 of file PtrListDictionary.C.

Referenced by main().

Here is the caller graph for this function:

set() [2/3]

Foam::autoPtr< T > set ( const label  i, const word &  key, autoPtr< T > &  aptr  )

inline

Set element to autoPtr value provided and return old element.

Definition at line 83 of file PtrListDictionary.C.

set() [3/3]

Foam::autoPtr< T > set ( const label  i, const word &  key, tmp< T > &  t  )

inline

Set element to tmp value provided and return old element.

Definition at line 102 of file PtrListDictionary.C.

operator[]() [1/2]

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

inline

Find and return entry.

Definition at line 93 of file PtrListDictionary.H.

operator[]() [2/2]

T& operator[] ( const word &  key )

inline

Find and return entry.

Definition at line 99 of file PtrListDictionary.H.

---

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

• src/OpenFOAM/containers/Dictionaries/PtrListDictionary/PtrListDictionary.H
• src/OpenFOAM/containers/Dictionaries/PtrListDictionary/PtrListDictionary.C