LPtrList Class Reference

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

Inheritance diagram for LPtrList:

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

Public Types
typedef T &	reference
	Type that can be used for storing into LPtrList::value_type. More...
typedef T &	const_reference
	Type that can be used for storing into constant. 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...
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...
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...

Private Member Functions
template<class INew >
void	read (Istream &, const INew &)
	Read from Istream using given Istream constructor class. More...

Friends
class	iterator
class	const_iterator
Istream &	operator>> (Istream &, LPtrList< LListBase, T > &)
Ostream &	operator (Ostream &, const LPtrList< LListBase, T > &)

Detailed Description

Template class for non-intrusive linked PtrLists.

Source files

• LPtrList.H
• LPtrList.C
• LPtrListIO.C

Definition at line 47 of file LPtrList.H.

Member Typedef Documentation

reference

typedef T& reference

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

objects.

Definition at line 170 of file LPtrList.H.

const_reference

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.

LListBase_iterator

typedef LListBase::iterator LListBase_iterator

Definition at line 179 of file LPtrList.H.

LListBase_const_iterator

typedef LListBase::const_iterator LListBase_const_iterator

Definition at line 212 of file LPtrList.H.

Constructor & Destructor Documentation

LPtrList() [1/5]

LPtrList ( )

inline

Null construct.

Definition at line 94 of file LPtrList.H.

LPtrList() [2/5]

LPtrList ( T *  a )

inline

Construct given initial T.

Definition at line 98 of file LPtrList.H.

LPtrList() [3/5]

LPtrList	(	Istream &	is,
		const INew &	iNew
	)

Construct from Istream using given Istream constructor class.

Definition at line 143 of file LPtrListIO.C.

LPtrList() [4/5]

LPtrList

(

Istream &

)

Construct from Istream using default Istream constructor class.

LPtrList() [5/5]

LPtrList

(

const LPtrList &

)

Construct as copy.

~LPtrList()

~LPtrList

(

)

Destructor.

Definition at line 45 of file LPtrList.C.

Member Function Documentation

read()

void read ( Istream &  is, const INew &  iNew  )

private

Read from Istream using given Istream constructor class.

Definition at line 35 of file LPtrListIO.C.

first() [1/2]

T& first ( )

inline

Return the first entry added.

Definition at line 123 of file LPtrList.H.

first() [2/2]

const T& first ( ) const

inline

Return const access to the first entry added.

Definition at line 129 of file LPtrList.H.

last() [1/2]

T& last ( )

inline

Return the last entry added.

Definition at line 135 of file LPtrList.H.

last() [2/2]

const T& last ( ) const

inline

Return const access to the last entry added.

Definition at line 141 of file LPtrList.H.

eraseHead()

bool eraseHead

(

)

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

Definition at line 54 of file LPtrList.C.

clear()

void clear

(

)

Clear the contents of the list.

Definition at line 70 of file LPtrList.C.

transfer()

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.

operator=()

void operator=

(

const LPtrList< LListBase, T > &

lst

)

Assign copy.

Definition at line 93 of file LPtrList.C.

Friends And Related Function Documentation

iterator

friend class iterator

friend

Definition at line 84 of file LPtrList.H.

const_iterator

friend class const_iterator

friend

Definition at line 87 of file LPtrList.H.

operator>>

Istream& operator>> ( Istream &  , LPtrList< LListBase, T > &    )

friend

operator

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

friend

---

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

• src/OpenFOAM/containers/LinkedLists/accessTypes/LPtrList/LPtrList.H
• src/OpenFOAM/containers/LinkedLists/accessTypes/LPtrList/LPtrList.C
• src/OpenFOAM/containers/LinkedLists/accessTypes/LPtrList/LPtrListIO.C