Template dictionary class which manages the storage associated with it. More...
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< T > | set (const label, const word &key, T *) |
| Set element to pointer provided and return old element. More... | |
| autoPtr< T > | set (const label, const word &key, autoPtr< T > &) |
| Set element to autoPtr value provided and return old element. More... | |
| autoPtr< T > | set (const label, const word &key, tmp< T > &) |
| Set element to tmp value provided and return old element. More... | |
| const T & | operator[] (const word &key) const |
| Find and return entry. More... | |
| T & | operator[] (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 T * | lookupPtr (const word &) const |
| Find and return an entry if present, otherwise return NULL. More... | |
| T * | lookupPtr (const word &) |
| Find and return an entry if present, otherwise return NULL. More... | |
| const T * | lookup (const word &) const |
| Find and return entry. More... | |
| T * | lookup (const word &) |
| Find and return entry. More... | |
| wordList | toc () const |
| Return the table of contents. More... | |
| wordList | sortedToc () const |
| Return the table of contents as a sorted list. More... | |
| void | insert (const word &, T *) |
| Add at head of dictionary. More... | |
| void | append (const word &, T *) |
| Add at tail of dictionary. More... | |
| T * | remove (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 T * | operator[] (const word &key) const |
| Find and return entry. More... | |
| T * | operator[] (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... | |
| 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< T > | set (const label, T *) |
| Set element to given T* and return old element (can be NULL) More... | |
| autoPtr< T > | set (const label, const autoPtr< T > &) |
| Set element to given autoPtr<T> and return old element. More... | |
| autoPtr< T > | set (const label, const tmp< T > &) |
| Set element to given tmp<T> and return old element. More... | |
| void | reorder (const labelUList &) |
| Reorders elements. Ordering does not have to be done in. More... | |
| void | operator= (const PtrList< T > &) |
| Assignment. More... | |
| Public Member Functions inherited from UPtrList< T > | |
| UPtrList () | |
| Null Constructor. More... | |
| UPtrList (const label) | |
| Construct with size specified. More... | |
| UPtrList (const Xfer< UPtrList< T >> &) | |
| Construct by transferring the parameter contents. More... | |
| UPtrList (UPtrList< T > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| label | size () const |
| Return the number of elements in the UPtrList. More... | |
| bool | empty () const |
| Return true if the UPtrList is empty (ie, size() is zero) More... | |
| T & | first () |
| Return reference to the first element of the list. More... | |
| const T & | first () const |
| Return reference to first element of the list. More... | |
| T & | last () |
| Return reference to the last element of the list. More... | |
| const T & | last () const |
| Return reference to the last element of the list. More... | |
| void | setSize (const label) |
| Reset size of UPtrList. This can only be used to set the size. More... | |
| void | resize (const label) |
| Reset size of UPtrList. This can only be used to set the size. More... | |
| void | clear () |
| Clear the UPtrList, i.e. set size to zero. More... | |
| void | transfer (UPtrList< T > &) |
| Transfer the contents of the argument UPtrList into this. More... | |
| Xfer< UPtrList< T > > | xfer () |
| Transfer contents to the Xfer container. More... | |
| bool | set (const label) const |
| Is element set. More... | |
| T * | set (const label, T *) |
| Set element. Return old element (can be NULL). More... | |
| void | reorder (const labelUList &) |
| Reorders elements. Ordering does not have to be done in. More... | |
| const T & | operator[] (const label) const |
| Return element const reference. More... | |
| T & | operator[] (const label) |
| Return element reference. More... | |
| const T * | operator() (const label) const |
| Return element const pointer. More... | |
| iterator | begin () |
| Return an iterator to begin traversing the UPtrList. More... | |
| iterator | end () |
| Return an iterator to end traversing the UPtrList. More... | |
| const_iterator | cbegin () const |
| Return an const_iterator to begin traversing the UPtrList. More... | |
| const_iterator | cend () const |
| Return an const_iterator to end traversing the UPtrList. More... | |
| const_iterator | begin () const |
| Return an const_iterator to begin traversing the UPtrList. More... | |
| const_iterator | end () const |
| Return an const_iterator to end traversing the UPtrList. More... | |
Additional Inherited Members | |
| Public Types inherited from UPtrList< T > | |
| typedef T | value_type |
| Type of values the UPtrList contains. More... | |
| typedef T & | reference |
| Type that can be used for storing into UPtrList::value_type objects. More... | |
| typedef const T & | const_reference |
| Type that can be used for storing into constant UPtrList::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... | |
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.
Definition at line 53 of file PtrListDictionary.H.
| PtrListDictionary | ( | const label | size | ) |
Construct given initial list size.
Definition at line 31 of file PtrListDictionary.C.
References PtrList< T >::setSize().
| 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.
| PtrListDictionary | ( | Istream & | is | ) |
Construct from Istream.
Definition at line 55 of file PtrListDictionary.C.
References PtrListDictionary< T >::set().
|
inline |
Set element to pointer provided and return old element.
Definition at line 65 of file PtrListDictionary.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, 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().
Set element to autoPtr value provided and return old element.
Definition at line 83 of file PtrListDictionary.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, DictionaryBase< PtrList< T >, T >::hashedTs_, HashTable< T, Key, Hash >::insert(), autoPtr< T >::ptr(), PtrListDictionary< T >::set(), PtrList< T >::set(), and Foam::T().
Set element to tmp value provided and return old element.
Definition at line 102 of file PtrListDictionary.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, DictionaryBase< PtrList< T >, T >::hashedTs_, HashTable< T, Key, Hash >::insert(), tmp< T >::ptr(), PtrList< T >::set(), and Foam::T().
Find and return entry.
Definition at line 93 of file PtrListDictionary.H.
Find and return entry.
Definition at line 99 of file PtrListDictionary.H.
1.8.11
