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

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

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

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< Tset (const label, const word &key, T *)
 Set element to pointer provided and return old element. More...
 
autoPtr< Tset (const label, const word &key, autoPtr< T > &)
 Set element to autoPtr value provided and return old element. More...
 
autoPtr< Tset (const label, const word &key, tmp< T > &)
 Set element to tmp value provided and return old element. 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< 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 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< PtrList< 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 PtrList< T >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< T > &)
 Copy constructor. More...
 
template<class CloneArg >
 PtrList (const PtrList< T > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< T > > &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< T > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< T > &)
 Construct as copy of SLPtrList<T> More...
 
template<class INew >
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
label size () const
 Return the number of elements in the PtrList. More...
 
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero). More...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. More...
 
void setSize (const label)
 Reset size of PtrList. If extending the PtrList, new entries are. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the. More...
 
void append (T *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< T > &)
 
void append (const tmp< T > &)
 
void transfer (PtrList< T > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< Tset (const label, T *)
 Set element. Return old element (can be NULL). More...
 
autoPtr< Tset (const label, const autoPtr< T > &)
 
autoPtr< Tset (const label, const tmp< T > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const Toperator[] (const label) const
 Return element const reference. More...
 
Toperator[] (const label)
 Return element reference. More...
 
const Toperator() (const label) const
 Return element const pointer. More...
 
PtrList< T > & operator= (const PtrList< T > &)
 Assignment. More...
 
iterator begin ()
 Return an iterator to begin traversing the PtrList. More...
 
iterator end ()
 Return an iterator to end traversing the PtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the PtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the PtrList. More...
 

Additional Inherited Members

- Public Types inherited from PtrList< T >
typedef T value_type
 Type of values the PtrList contains. More...
 
typedef Treference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant PtrList::value_type. More...
 
- Protected Member Functions inherited from DictionaryBase< PtrList< T >, T >
void addEntries ()
 
- Protected Member Functions inherited from PtrList< T >
template<class INew >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 
- 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

Definition at line 53 of file PtrListDictionary.H.

Constructor & Destructor Documentation

PtrListDictionary ( const label  size)

Construct given initial list size.

Definition at line 31 of file PtrListDictionary.C.

References PtrList< T >::setSize().

Here is the call graph for this function:

PtrListDictionary ( const PtrListDictionary< T > &  dict)

Copy construct.

Definition at line 40 of file PtrListDictionary.C.

PtrListDictionary ( Istream is,
const INew iNew 
)

Construct from Istream using given Istream constructor class.

Definition at line 48 of file PtrListDictionary.C.

Construct from Istream.

Definition at line 55 of file PtrListDictionary.C.

References PtrListDictionary< T >::set().

Here is the call graph for this function:

Member Function Documentation

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.

References Foam::abort(), Foam::FatalError, FatalErrorIn, DictionaryBase< PtrList< T >, T >::hashedTs_, HashTable< T, Key, Hash >::insert(), PtrList< T >::set(), and Foam::T().

Referenced by PtrListDictionary< T >::PtrListDictionary(), and PtrListDictionary< T >::set().

Here is the call graph for this function:

Here is the caller graph for this function:

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 85 of file PtrListDictionary.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, DictionaryBase< PtrList< T >, T >::hashedTs_, HashTable< T, Key, Hash >::insert(), autoPtr< T >::ptr(), PtrListDictionary< T >::set(), PtrList< T >::set(), and Foam::T().

Here is the call graph for this function:

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 107 of file PtrListDictionary.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, DictionaryBase< PtrList< T >, T >::hashedTs_, HashTable< T, Key, Hash >::insert(), tmp< T >::ptr(), PtrList< T >::set(), and Foam::T().

Here is the call graph for this function:

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

Find and return entry.

Definition at line 93 of file PtrListDictionary.H.

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: