Public Types | Public Member Functions | Friends | List of all members
HashPtrTable< T, Key, Hash > Class Template Reference

A HashTable of pointers to objects of type <T>. More...

Inheritance diagram for HashPtrTable< T, Key, Hash >:
[legend]

Public Types

typedef HashPtrTable< T, Key, Hash > this_type
 The template instance used for this table. More...
 
typedef HashTable< T *, Key, Hash > parent_type
 The template instance used for the parent HashTable. More...
 
using iterator = typename parent_type::iterator
 
using const_iterator = typename parent_type::const_iterator
 

Public Member Functions

 HashPtrTable ()
 Construct null with default table capacity. More...
 
 HashPtrTable (const label size)
 Construct given initial table capacity. More...
 
template<class INew >
 HashPtrTable (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 HashPtrTable (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
 HashPtrTable (const dictionary &dict)
 Construct from dictionary with default dictionary constructor class. More...
 
 HashPtrTable (const this_type &ht)
 Copy construct. More...
 
 HashPtrTable (this_type &&ht)
 Move construct. More...
 
 ~HashPtrTable ()
 Destructor. More...
 
autoPtr< T > remove (iterator &iter)
 Remove entry specified by given iterator. More...
 
autoPtr< T > remove (const Key &key)
 Remove entry specified by given key. More...
 
bool erase (iterator &iter)
 
bool erase (const Key &key)
 
void clear ()
 Clear all entries from table and delete any allocated pointers. More...
 
void write (Ostream &os) const
 Write. More...
 
void operator= (const this_type &rhs)
 Copy assignment. More...
 
void operator= (this_type &&rhs)
 Move assignment. More...
 
bool insert (const Key &, T *)=delete
 
bool insert (const Key &key, autoPtr< T > &aptr)
 Insert a new entry, not overwriting existing entries. More...
 
bool insert (const Key &key, autoPtr< T > &&aptr)
 Insert a new entry, not overwriting existing entries. More...
 
bool set (const Key &key, T *ptr)
 Assign a new entry, overwriting existing entries. More...
 
bool set (const Key &key, autoPtr< T > &aptr)
 Assign a new entry, overwriting existing entries. More...
 
bool set (const Key &key, autoPtr< T > &&aptr)
 Assign a new entry, overwriting existing entries. More...
 

Friends

Istream & operator>> (Istream &is, HashPtrTable< T, Key, Hash > &tbl)
 

Detailed Description

template<class T, class Key = word, class Hash = string::hash>
class Foam::HashPtrTable< T, Key, Hash >

A HashTable of pointers to objects of type <T>.

Source files

Definition at line 54 of file HashPtrTable.H.

Member Typedef Documentation

◆ this_type

typedef HashPtrTable<T, Key, Hash> this_type

The template instance used for this table.

Definition at line 83 of file HashPtrTable.H.

◆ parent_type

typedef HashTable<T*, Key, Hash> parent_type

The template instance used for the parent HashTable.

Definition at line 86 of file HashPtrTable.H.

◆ iterator

using iterator = typename parent_type::iterator

Definition at line 88 of file HashPtrTable.H.

◆ const_iterator

using const_iterator = typename parent_type::const_iterator

Definition at line 89 of file HashPtrTable.H.

Constructor & Destructor Documentation

◆ HashPtrTable() [1/7]

HashPtrTable ( )
inline

Construct null with default table capacity.

Definition at line 33 of file HashPtrTableI.H.

◆ HashPtrTable() [2/7]

HashPtrTable ( const label  size)
inlineexplicit

Construct given initial table capacity.

Definition at line 40 of file HashPtrTableI.H.

◆ HashPtrTable() [3/7]

HashPtrTable ( Istream &  is,
const INew &  inew 
)

Construct from Istream using given Istream constructor class.

Definition at line 172 of file HashPtrTableIO.C.

◆ HashPtrTable() [4/7]

HashPtrTable ( Istream &  is)

Construct from Istream using default Istream constructor class.

Definition at line 179 of file HashPtrTableIO.C.

◆ HashPtrTable() [5/7]

HashPtrTable ( const dictionary &  dict)
explicit

Construct from dictionary with default dictionary constructor class.

Definition at line 186 of file HashPtrTableIO.C.

◆ HashPtrTable() [6/7]

HashPtrTable ( const this_type &  ht)

Copy construct.

◆ HashPtrTable() [7/7]

HashPtrTable ( this_type &&  ht)

Move construct.

◆ ~HashPtrTable()

~HashPtrTable ( )

Destructor.

Definition at line 70 of file HashPtrTable.C.

Member Function Documentation

◆ remove() [1/2]

Foam::autoPtr< T > remove ( iterator &  iter)

Remove entry specified by given iterator.

Includes a safeguard against the end-iterator.

Returns
entry as an encapsulated pointer.

Definition at line 79 of file HashPtrTable.C.

◆ remove() [2/2]

Foam::autoPtr< T > remove ( const Key &  key)

Remove entry specified by given key.

Returns
entry as an encapsulated pointer.

Definition at line 93 of file HashPtrTable.C.

◆ erase() [1/2]

bool erase ( iterator &  iter)

Erase entry specified by given iterator and delete the allocated pointer.

Includes a safeguard against the end-iterator.

Returns
True if item was removed

Definition at line 101 of file HashPtrTable.C.

◆ erase() [2/2]

bool erase ( const Key &  key)

Erase entry specified by given key and delete the allocated pointer.

Returns
True if item was removed

Definition at line 123 of file HashPtrTable.C.

◆ clear()

void clear ( )

Clear all entries from table and delete any allocated pointers.

Definition at line 131 of file HashPtrTable.C.

◆ write()

void write ( Ostream &  os) const

Write.

Definition at line 155 of file HashPtrTableIO.C.

◆ operator=() [1/2]

void operator= ( const this_type &  rhs)

Copy assignment.

Referenced by PtrMap< Foam::coordSystem::cylindrical >::operator=().

Here is the caller graph for this function:

◆ operator=() [2/2]

void operator= ( this_type &&  rhs)

Move assignment.

◆ insert() [1/3]

bool insert ( const Key &  ,
T *   
)
inlinedelete

No insert() with raw pointers (potential memory leaks). Use insert() with autoPtr or set()

◆ insert() [2/3]

bool insert ( const Key &  key,
autoPtr< T > &  aptr 
)
inline

Insert a new entry, not overwriting existing entries.

Returns
True if the entry inserted (not previously in table)

Definition at line 50 of file HashPtrTableI.H.

◆ insert() [3/3]

bool insert ( const Key &  key,
autoPtr< T > &&  aptr 
)
inline

Insert a new entry, not overwriting existing entries.

Returns
True if the entry inserted (not previously in table)

Definition at line 67 of file HashPtrTableI.H.

◆ set() [1/3]

bool set ( const Key &  key,
T *  ptr 
)
inline

Assign a new entry, overwriting existing entries.

Definition at line 84 of file HashPtrTableI.H.

Referenced by phaseSystem::addField(), exprResultGlobals::addValue(), phaseSystem::fillFields(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), PhaseTransferPhaseSystem< BasePhaseSystem >::massTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer(), and MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf().

Here is the caller graph for this function:

◆ set() [2/3]

bool set ( const Key &  key,
autoPtr< T > &  aptr 
)
inline

Assign a new entry, overwriting existing entries.

Definition at line 95 of file HashPtrTableI.H.

◆ set() [3/3]

bool set ( const Key &  key,
autoPtr< T > &&  aptr 
)
inline

Assign a new entry, overwriting existing entries.

Definition at line 106 of file HashPtrTableI.H.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream &  is,
HashPtrTable< T, Key, Hash > &  tbl 
)
friend
The documentation for this class was generated from the following files: