FreeFOAM The Cross-Platform CFD Toolkit
PackedList< nBits >::iterator Class Reference

The iterator class used for PackedList. More...

#include <src/OpenFOAM/containers/Lists/PackedList/PackedList.H>


Detailed Description

template<unsigned nBits = 1>
class Foam::PackedList< nBits >::iterator

The iterator class used for PackedList.

Definition at line 361 of file PackedList.H.

+ Inheritance diagram for PackedList< nBits >::iterator:
+ Collaboration diagram for PackedList< nBits >::iterator:

List of all members.

Public Member Functions

 iterator ()
 Construct null.
 iterator (const iteratorBase &)
 Construct from iterator base, eg iter(packedlist[i])
 iterator (const PackedList *, const label)
 Construct from base list and position index.
bool operator== (const iteratorBase &) const
 Compare positions (not values)
bool operator!= (const iteratorBase &) const
iteratoroperator= (const iteratorBase &)
 Assign from iteratorBase, eg iter = packedlist[i].
unsigned int operator* () const
 Return value.
unsigned int operator() () const
 Return value.
iteratorBaseoperator* ()
 Return iteratorBase for assigning values.
iteratorBaseoperator() ()
 Return iteratorBase for assigning values.
iteratoroperator++ ()
iterator operator++ (int)
iteratoroperator-- ()
iterator operator-- (int)
- Public Member Functions inherited from PackedList< nBits >::iteratorBase
unsigned int operator= (const unsigned int val)
 Assign value.
 operator unsigned int () const
 Conversion operator.
Ostreamprint (Ostream &) const
 Print value and information.

Additional Inherited Members

- Protected Member Functions inherited from PackedList< nBits >::iteratorBase
unsigned int get () const
 Get value as unsigned, no range-checking.
bool set (unsigned int)
 Set value, returning true if changed, no range-checking.
 iteratorBase ()
 Construct null.
 iteratorBase (const PackedList *, const label)
 Construct from base list and position index.
- Protected Attributes inherited from PackedList< nBits >::iteratorBase
PackedListlist_
 Pointer to original list.
label index_
 Element index.

Constructor & Destructor Documentation

iterator ( )
inline

Construct null.

Definition at line 237 of file PackedListI.H.

iterator ( const iteratorBase iter)
inline

Construct from iterator base, eg iter(packedlist[i])

but also "iterator iter = packedlist[i];" An out-of-range iterator is assigned end()

Definition at line 252 of file PackedListI.H.

iterator ( const PackedList ,
const label   
)
inline

Construct from base list and position index.


Member Function Documentation

bool operator== ( const iteratorBase iter) const
inline

Compare positions (not values)

Reimplemented from PackedList< nBits >::iteratorBase.

Definition at line 318 of file PackedListI.H.

References PackedList< nBits >::iteratorBase::index_.

bool operator!= ( const iteratorBase iter) const
inline

Reimplemented from PackedList< nBits >::iteratorBase.

Definition at line 328 of file PackedListI.H.

References PackedList< nBits >::iteratorBase::index_.

Foam::PackedList< nBits >::iterator & operator= ( const iteratorBase iter)
inline

Assign from iteratorBase, eg iter = packedlist[i].

An out-of-range iterator is assigned end()

Reimplemented from PackedList< nBits >::iteratorBase.

Definition at line 360 of file PackedListI.H.

References PackedList< nBits >::iteratorBase::index_, and PackedList< nBits >::iteratorBase::list_.

unsigned int operator* ( ) const
inline

Return value.

unsigned int operator() ( ) const
inline

Return value.

Foam::PackedList< nBits >::iteratorBase & operator* ( )
inline

Return iteratorBase for assigning values.

Definition at line 472 of file PackedListI.H.

Foam::PackedList< nBits >::iteratorBase & operator() ( )
inline

Return iteratorBase for assigning values.

Definition at line 480 of file PackedListI.H.

Foam::PackedList< nBits >::iterator & operator++ ( )
inline

Definition at line 396 of file PackedListI.H.

Foam::PackedList< nBits >::iterator operator++ ( int  )
inline

Definition at line 414 of file PackedListI.H.

Foam::PackedList< nBits >::iterator & operator-- ( )
inline

Definition at line 434 of file PackedListI.H.

Foam::PackedList< nBits >::iterator operator-- ( int  )
inline

Definition at line 452 of file PackedListI.H.


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