Public Member Functions | List of all members
PtrDictionary< T > Class Template Reference

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

Inheritance diagram for PtrDictionary< T >:
Inheritance graph
[legend]
Collaboration diagram for PtrDictionary< T >:
Collaboration graph
[legend]

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from LPtrList< DLListBase, T >
typedef Treference
 Type that can be used for storing into LPtrList::value_type. More...
 
typedef Tconst_reference
 Type that can be used for storing into constant. More...
 
typedef DLListBase::iterator LListBase_iterator
 
typedef DLListBase::const_iterator LListBase_const_iterator
 
- Public Types inherited from LList< DLListBase, T * >
typedef Tvalue_type
 Type of values the LList contains. More...
 
typedef T * & reference
 Type that can be used for storing into value_type. More...
 
typedef const T * & const_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a LList. More...
 
typedef DLListBase::iterator LListBase_iterator
 
typedef DLListBase::const_iterator LListBase_const_iterator
 
- Protected Member Functions inherited from DictionaryBase< DLPtrList< T >, T >
void addEntries ()
 
- Protected Attributes inherited from DictionaryBase< DLPtrList< T >, T >
HashTable< T * > hashedTs_
 HashTable of the entries held on the IDLListType for quick lookup. More...
 

Detailed Description

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

Template dictionary class which manages the storage associated with it.

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

Source files

Definition at line 53 of file PtrDictionary.H.

Constructor & Destructor Documentation

PtrDictionary ( const label  size = 128)

Construct given initial table size.

Definition at line 31 of file PtrDictionary.C.

PtrDictionary ( const PtrDictionary< T > &  dict)

Copy construct.

Definition at line 38 of file PtrDictionary.C.

PtrDictionary ( Istream is,
const INew iNew 
)

Construct from Istream using given Istream constructor class.

Definition at line 46 of file PtrDictionary.C.

Construct from Istream.

Definition at line 53 of file PtrDictionary.C.

Member Function Documentation

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

Find and return entry.

Definition at line 79 of file PtrDictionary.H.

T& operator[] ( const word key)
inline

Find and return entry.

Definition at line 85 of file PtrDictionary.H.


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