Classes | Public Types | Public Member Functions | Public Attributes | Friends | List of all members
UILList Class Reference

Template class for intrusive linked lists. More...

Inheritance diagram for UILList:
Inheritance graph
[legend]

Classes

class  const_iterator
 
class  const_reverse_iterator
 
class  iterator
 
class  reverse_iterator
 

Public Types

typedef T value_type
 
typedef T * pointer
 
typedef T & reference
 
typedef label size_type
 
typedef label difference_type
 
using base_iterator = typename LListBase::iterator
 
using const_base_iterator = typename LListBase::const_iterator
 

Public Member Functions

 UILList ()=default
 
 UILList (T *item)
 
 UILList (const UILList< LListBase, T > &lst)
 
T * first ()
 
const T * first () const
 
T * last ()
 
const T * last () const
 
T * removeHead ()
 
T * remove (T *item)
 
T * remove (iterator &iter)
 
void operator= (const UILList< LListBase, T > &lst)
 
bool operator== (const UILList< LListBase, T > &lst) const
 
bool operator!= (const UILList< LListBase, T > &lst) const
 
Ostream & writeList (Ostream &os, const label shortLen=0) const
 
iterator begin ()
 
const_iterator cbegin () const
 
reverse_iterator rbegin ()
 
const_reverse_iterator crbegin () const
 
const_iterator begin () const
 
const_reverse_iterator rbegin () const
 
const iterator & end ()
 
const const_iterator & cend () const
 
const reverse_iterator & rend ()
 
const const_reverse_iterator & crend () const
 
const const_iterator & end () const
 
const const_reverse_iterator & rend () const
 

Public Attributes

const typedef T * const_pointer
 
const typedef T & const_reference
 

Friends

Ostream & operator (Ostream &os, const UILList< LListBase, T > &lst)
 

Detailed Description

Template class for intrusive linked lists.

Source files

Definition at line 48 of file UILList.H.

Member Typedef Documentation

◆ value_type

typedef T value_type

Definition at line 72 of file UILList.H.

◆ pointer

typedef T* pointer

Definition at line 75 of file UILList.H.

◆ reference

typedef T& reference

Definition at line 81 of file UILList.H.

◆ size_type

typedef label size_type

Definition at line 87 of file UILList.H.

◆ difference_type

typedef label difference_type

Definition at line 90 of file UILList.H.

◆ base_iterator

using base_iterator = typename LListBase::iterator

Definition at line 98 of file UILList.H.

◆ const_base_iterator

using const_base_iterator = typename LListBase::const_iterator

Definition at line 99 of file UILList.H.

Constructor & Destructor Documentation

◆ UILList() [1/3]

UILList ( )
default

◆ UILList() [2/3]

UILList ( T *  item)
inlineexplicit

Definition at line 108 of file UILList.H.

References insert().

Here is the call graph for this function:

◆ UILList() [3/3]

UILList ( const UILList< LListBase, T > &  lst)

Definition at line 27 of file UILList.C.

References append(), UILList::cbegin(), and UILList::cend().

Here is the call graph for this function:

Member Function Documentation

◆ first() [1/2]

T* first ( )
inline

Definition at line 120 of file UILList.H.

References Foam::T().

Here is the call graph for this function:

◆ first() [2/2]

const T* first ( ) const
inline

Definition at line 126 of file UILList.H.

References Foam::T().

Here is the call graph for this function:

◆ last() [1/2]

T* last ( )
inline

Definition at line 132 of file UILList.H.

References Foam::T().

Here is the call graph for this function:

◆ last() [2/2]

const T* last ( ) const
inline

Definition at line 138 of file UILList.H.

References Foam::T().

Here is the call graph for this function:

◆ removeHead()

T* removeHead ( )
inline

Definition at line 145 of file UILList.H.

References Foam::T().

Here is the call graph for this function:

◆ remove() [1/2]

T* remove ( T *  item)
inline

Definition at line 151 of file UILList.H.

References Foam::T().

Here is the call graph for this function:

◆ remove() [2/2]

T* remove ( iterator &  iter)
inline

Definition at line 157 of file UILList.H.

References Foam::T().

Here is the call graph for this function:

◆ operator=()

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

Definition at line 39 of file UILList.C.

References append(), UILList::cbegin(), UILList::cend(), and clear().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const UILList< LListBase, T > &  lst) const

Definition at line 52 of file UILList.C.

References stdFoam::cbegin(), UILList::cbegin(), and stdFoam::cend().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const UILList< LListBase, T > &  lst) const

Definition at line 77 of file UILList.C.

References Foam::operator==().

Here is the call graph for this function:

◆ writeList()

Foam::Ostream & writeList ( Ostream &  os,
const label  shortLen = 0 
) const

Definition at line 30 of file UILListIO.C.

References FUNCTION_NAME, Foam::nl, os(), and T.

Here is the call graph for this function:

◆ begin() [1/2]

iterator begin ( )
inline

Definition at line 373 of file UILList.H.

◆ cbegin()

const_iterator cbegin ( ) const
inline

Definition at line 379 of file UILList.H.

Referenced by UILList::operator=(), UILList::operator==(), and UILList::UILList().

Here is the caller graph for this function:

◆ rbegin() [1/2]

reverse_iterator rbegin ( )
inline

Definition at line 385 of file UILList.H.

◆ crbegin()

const_reverse_iterator crbegin ( ) const
inline

Definition at line 391 of file UILList.H.

Referenced by UILList::rbegin().

Here is the caller graph for this function:

◆ begin() [2/2]

const_iterator begin ( ) const
inline

Definition at line 397 of file UILList.H.

References stdFoam::cbegin().

Here is the call graph for this function:

◆ rbegin() [2/2]

const_reverse_iterator rbegin ( ) const
inline

Definition at line 403 of file UILList.H.

References UILList::crbegin().

Here is the call graph for this function:

◆ end() [1/2]

const iterator& end ( )
inline

Definition at line 410 of file UILList.H.

◆ cend()

const const_iterator& cend ( ) const
inline

Definition at line 416 of file UILList.H.

Referenced by UILList::end(), UILList::operator=(), and UILList::UILList().

Here is the caller graph for this function:

◆ rend() [1/2]

const reverse_iterator& rend ( )
inline

Definition at line 422 of file UILList.H.

◆ crend()

const const_reverse_iterator& crend ( ) const
inline

Definition at line 428 of file UILList.H.

Referenced by UILList::rend().

Here is the caller graph for this function:

◆ end() [2/2]

const const_iterator& end ( ) const
inline

Definition at line 434 of file UILList.H.

References UILList::cend().

Here is the call graph for this function:

◆ rend() [2/2]

const const_reverse_iterator& rend ( ) const
inline

Definition at line 440 of file UILList.H.

References UILList::crend().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream &  os,
const UILList< LListBase, T > &  lst 
)
friend

Member Data Documentation

◆ const_pointer

const typedef T* const_pointer

Definition at line 78 of file UILList.H.

◆ const_reference

const typedef T& const_reference

Definition at line 84 of file UILList.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17