FreeFOAM The Cross-Platform CFD Toolkit
PtrDictionary< T > Class Template Reference

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

#include <OpenFOAM/PtrDictionary.H>


Detailed Description

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

Template dictionary class which does not manages the storage associated with it.

It is derived from DictionaryBase instantiated on a non-memory managed form of intrusive doubly-linked list of T.

Source files

Definition at line 55 of file PtrDictionary.H.

+ Inheritance diagram for PtrDictionary< T >:
+ Collaboration diagram for PtrDictionary< T >:

List of all members.

Public Member Functions

 PtrDictionary ()
 Null constructor.
 PtrDictionary (const PtrDictionary &)
 Copy construct.
template<class INew >
 PtrDictionary (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 PtrDictionary (Istream &)
 Construct from Istream.
- Public Member Functions inherited from DictionaryBase< DLPtrList< T >, T >
 DictionaryBase ()
 Null constructor.
 DictionaryBase (const DictionaryBase &)
 Copy construct.
 DictionaryBase (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 DictionaryBase (Istream &)
 Construct from Istream using default Istream constructor class.
bool found (const word &) const
 Search DictionaryBase for given keyword.
const TlookupPtr (const word &) const
 Find and return an entry if present, otherwise return NULL.
TlookupPtr (const word &)
 Find and return an entry if present, otherwise return NULL.
const Tlookup (const word &) const
 Find and return entry.
Tlookup (const word &)
 Find and return entry.
wordList toc () const
 Return the table of contents.
void insert (const word &, T *)
 Add at head of dictionary.
void append (const word &, T *)
 Add at tail of dictionary.
Tremove (const word &)
 Remove and return entry specified by keyword.
void clear ()
 Clear the dictionary.
void transfer (DictionaryBase< DLPtrList< T >, T > &)
 Transfer the contents of the argument into this DictionaryBase.
void operator= (const DictionaryBase &)
const Toperator[] (const word &key) const
 Find and return entry.
Toperator[] (const word &key)
 Find and return entry.
- Public Member Functions inherited from DLPtrList< T >
 DLPtrList ()
 Null construct.
 DLPtrList (T a)
 Construct given initial T.
template<class INew >
 DLPtrList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class.
 DLPtrList (Istream &is)
 Construct from Istream.
- Public Member Functions inherited from LPtrList< DLListBase, T >
 LPtrList ()
 Null construct.
 LPtrList (T *a)
 Construct given initial T.
 LPtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 LPtrList (Istream &)
 Construct from Istream using default Istream constructor class.
 LPtrList (const LPtrList &)
 Construct as copy.
 ~LPtrList ()
Tfirst ()
 Return the first entry added.
const Tfirst () const
 Return const access to the first entry added.
Tlast ()
 Return the last entry added.
const Tlast () const
 Return const access to the last entry added.
bool eraseHead ()
 Remove the head element from the list and delete the pointer.
void transfer (LPtrList< DLListBase, T > &)
 Transfer the contents of the argument into this List.
void operator= (const LPtrList< DLListBase, T > &)
 Assign copy.
- Public Member Functions inherited from LList< DLListBase, T * >
 LList ()
 Null construct.
 LList (T *a)
 Construct given initial T.
 LList (Istream &)
 Construct from Istream.
 LList (const LList< DLListBase, T * > &)
 Construct as copy.
 ~LList ()
void insert (const T *&a)
 Add at head of list.
void append (const T *&a)
 Add at tail of list.
TremoveHead ()
 Remove and return head.
Tremove (link *l)
 Remove and return element.
Tremove (iterator &it)
 Remove and return element specified by iterator.
void transfer (LList< DLListBase, T * > &)
 Transfer the contents of the argument into this List.
void operator= (const LList< DLListBase, T * > &)
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct.
 DLListBase (link *)
 Construct given initial entry.
 ~DLListBase ()
label size () const
 Return number of elements in list.
bool empty () const
 Return true if the list is empty.
void insert (link *)
 Add at head of list.
void append (link *)
 Add at tail of list.
bool swapUp (link *)
 Swap this element with the one above unless it is at the top.
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom.
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element.
linkreplace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element.
void transfer (DLListBase &)
 Transfer the contents of the argument into this List.
iterator begin ()
const iteratorend ()
const_iterator cbegin () const
const const_iteratorcend () const
const_iterator begin () const
const const_iteratorend () const

Constructor & Destructor Documentation

Null constructor.

Definition at line 31 of file PtrDictionary.C.

PtrDictionary ( const PtrDictionary< T > &  dict)

Copy construct.

Definition at line 36 of file PtrDictionary.C.

PtrDictionary ( Istream is,
const INew iNew 
)

Construct from Istream using given Istream constructor class.

Definition at line 44 of file PtrDictionary.C.

Construct from Istream.

Definition at line 51 of file PtrDictionary.C.


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