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

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

#include <OpenFOAM/UDictionary.H>


Detailed Description

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

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

List of all members.

Public Member Functions

 UDictionary ()
 Null constructor.
 UDictionary (const UDictionary &)
 Copy construct.
- Public Member Functions inherited from DictionaryBase< UIDLList< 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 T * lookupPtr (const word &) const
 Find and return an entry if present, otherwise return NULL.
T * lookupPtr (const word &)
 Find and return an entry if present, otherwise return NULL.
const T * lookup (const word &) const
 Find and return entry.
T * lookup (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.
T * remove (const word &)
 Remove and return entry specified by keyword.
void clear ()
 Clear the dictionary.
void transfer (DictionaryBase< UIDLList< T >, T > &)
 Transfer the contents of the argument into this DictionaryBase.
void operator= (const DictionaryBase &)
const T * operator[] (const word &key) const
 Find and return entry.
T * operator[] (const word &key)
 Find and return entry.
- Public Member Functions inherited from UIDLList< T >
 UIDLList ()
 Null construct.
 UIDLList (T a)
 Construct given initial T.
 UIDLList (Istream &is)
 Construct from Istream.
- Public Member Functions inherited from UILList< DLListBase, T >
 UILList ()
 Null construct.
 UILList (T *a)
 Construct given initial T.
 UILList (const UILList< DLListBase, T > &)
 Construct as copy.
T * first ()
 Return the first entry.
const T * first () const
 Return the first entry.
T * last ()
 Return the last entry.
const T * last () const
 Return the last entry.
T * removeHead ()
 Remove and return head.
T * remove (T *p)
 Remove and return element.
T * remove (iterator &it)
 Remove and return specified by iterator.
void operator= (const UILList< DLListBase, T > &)
bool operator== (const UILList< DLListBase, T > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UILList< DLListBase, T > &) const
 The opposite of the equality operation. Takes linear time.
- 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.
link * remove (link *)
 Remove and return element.
link * replace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element.
link * replace (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 iterator & end ()
const_iterator cbegin () const
const const_iterator & cend () const
const_iterator begin () const
const const_iterator & end () const

Constructor & Destructor Documentation

Null constructor.

Definition at line 31 of file UDictionary.C.

UDictionary ( const UDictionary< T > &  dict)

Copy construct.

Definition at line 36 of file UDictionary.C.


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