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

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

#include <OpenFOAM/UPtrDictionary.H>


Detailed Description

template<class T>
class Foam::UPtrDictionary< 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 UPtrDictionary.H.

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

List of all members.

Public Member Functions

 UPtrDictionary ()
 Null constructor.
 UPtrDictionary (const UPtrDictionary &)
 Copy construct.
- Public Member Functions inherited from DictionaryBase< DLList< 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< DLList< 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 DLList< T * >
 DLList ()
 Null construct.
 DLList (T *a)
 Construct given initial T.
 DLList (Istream &is)
 Construct from Istream.
- 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 ()
T *& first ()
 Return the first entry added.
const T *& first () const
 Return const access to the first entry added.
T *& last ()
 Return the last entry added.
const T *& last () const
 Return const access to the last entry added.
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 UPtrDictionary.C.

UPtrDictionary ( const UPtrDictionary< T > &  dict)

Copy construct.

Definition at line 36 of file UPtrDictionary.C.


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