Classes | Public Types | Public Member Functions | Friends | List of all members
LPtrList< LListBase, T > Class Template Reference

Template class for non-intrusive linked PtrLists. More...

Inheritance diagram for LPtrList< LListBase, T >:
Inheritance graph
[legend]
Collaboration diagram for LPtrList< LListBase, T >:
Collaboration graph
[legend]

Classes

class  const_iterator
 An STL-conforming const_iterator. More...
 
class  iterator
 An STL-conforming iterator. More...
 

Public Types

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 LListBase::iterator LListBase_iterator
 
typedef LListBase::const_iterator LListBase_const_iterator
 
- Public Types inherited from LList< LListBase, 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 LListBase::iterator LListBase_iterator
 
typedef LListBase::const_iterator LListBase_const_iterator
 

Public Member Functions

 LPtrList ()
 Null construct. More...
 
 LPtrList (T *a)
 Construct given initial T. More...
 
template<class INew >
 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< LListBase, T > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const LPtrList< LListBase, T > &)
 Assign copy. More...
 
- Public Member Functions inherited from LList< LListBase, T * >
 LList ()
 Null construct. More...
 
 LList (T *a)
 Construct given initial T. More...
 
 LList (Istream &)
 Construct from Istream. More...
 
 LList (const LList< LListBase, 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< LListBase, T * > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const LList< LListBase, T * > &)
 
iterator begin ()
 
const_iterator begin () const
 
const iteratorend ()
 
const const_iteratorend () const
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 

Friends

class iterator
 
class const_iterator
 
Istreamoperator>> (Istream &, LPtrList< LListBase, T > &)
 
Ostreamoperator (Ostream &, const LPtrList< LListBase, T > &)
 

Detailed Description

template<class LListBase, class T>
class Foam::LPtrList< LListBase, T >

Template class for non-intrusive linked PtrLists.

Source files

Definition at line 47 of file LPtrList.H.

Member Typedef Documentation

typedef T& reference

Type that can be used for storing into LPtrList::value_type.

objects.

Definition at line 170 of file LPtrList.H.

typedef T& const_reference

Type that can be used for storing into constant.

LPtrList::value_type objects.

Definition at line 174 of file LPtrList.H.

typedef LListBase::iterator LListBase_iterator

Definition at line 179 of file LPtrList.H.

typedef LListBase::const_iterator LListBase_const_iterator

Definition at line 212 of file LPtrList.H.

Constructor & Destructor Documentation

LPtrList ( )
inline

Null construct.

Definition at line 94 of file LPtrList.H.

Referenced by LPtrList< DLListBase, Foam::phaseModel >::LPtrList().

Here is the caller graph for this function:

LPtrList ( T a)
inline

Construct given initial T.

Definition at line 98 of file LPtrList.H.

LPtrList ( Istream is,
const INew iNew 
)

Construct from Istream using given Istream constructor class.

Definition at line 143 of file LPtrListIO.C.

References Foam::read().

Here is the call graph for this function:

LPtrList ( Istream is)

Construct from Istream using default Istream constructor class.

Definition at line 150 of file LPtrListIO.C.

References LPtrList< LListBase, T >::clear(), Foam::nl, Foam::operator>>(), and Foam::read().

Here is the call graph for this function:

LPtrList ( const LPtrList< LListBase, T > &  )

Construct as copy.

~LPtrList ( )

Destructor.

Definition at line 45 of file LPtrList.C.

References LList< LListBase, T >::clear().

Referenced by LPtrList< DLListBase, Foam::phaseModel >::LPtrList().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

T& first ( )
inline

Return the first entry added.

Definition at line 123 of file LPtrList.H.

const T& first ( ) const
inline

Return const access to the first entry added.

Definition at line 129 of file LPtrList.H.

T& last ( )
inline

Return the last entry added.

Definition at line 135 of file LPtrList.H.

const T& last ( ) const
inline

Return const access to the last entry added.

Definition at line 141 of file LPtrList.H.

bool eraseHead ( )

Remove the head element from the list and delete the pointer.

Definition at line 54 of file LPtrList.C.

References LList< LListBase, T >::removeHead(), and Foam::T().

Referenced by LPtrList< DLListBase, Foam::phaseModel >::last().

Here is the call graph for this function:

Here is the caller graph for this function:

void clear ( )

Clear the contents of the list.

Definition at line 70 of file LPtrList.C.

References LList< LListBase, T >::clear().

Referenced by LPtrList< DLListBase, Foam::phaseModel >::last(), and LPtrList< LListBase, T >::LPtrList().

Here is the call graph for this function:

Here is the caller graph for this function:

void transfer ( LPtrList< LListBase, T > &  lst)

Transfer the contents of the argument into this List.

and annul the argument list.

Definition at line 83 of file LPtrList.C.

References LList< LListBase, T >::clear(), and LList< LListBase, T >::transfer().

Referenced by LPtrList< DLListBase, Foam::phaseModel >::last().

Here is the call graph for this function:

Here is the caller graph for this function:

void operator= ( const LPtrList< LListBase, T > &  lst)

Assign copy.

Definition at line 93 of file LPtrList.C.

References LList< LListBase, T >::append(), LList< LListBase, T * >::begin(), LList< LListBase, T >::clear(), and LList< LListBase, T * >::end().

Referenced by LPtrList< DLListBase, Foam::phaseModel >::last().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class iterator
friend

Definition at line 84 of file LPtrList.H.

friend class const_iterator
friend

Definition at line 87 of file LPtrList.H.

Istream& operator>> ( Istream ,
LPtrList< LListBase, T > &   
)
friend
Ostream& operator ( Ostream ,
const LPtrList< LListBase, T > &   
)
friend

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