FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

PackedList< nBits >::const_iterator Class Reference

The const_iterator for PackedList. More...

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


Detailed Description

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

The const_iterator for PackedList.

Definition at line 425 of file PackedList.H.

Inheritance diagram for PackedList< nBits >::const_iterator:
Collaboration diagram for PackedList< nBits >::const_iterator:

List of all members.

Public Member Functions

 const_iterator ()
 Construct null.
 const_iterator (const iteratorBase &)
 Construct from iterator base, eg iter(packedlist[i])
 const_iterator (const PackedList *, const label)
 Construct from base list and position index.
 const_iterator (const iterator &)
 Construct from iterator.
bool  operator== (const iteratorBase &) const
 Compare positions (not values)
bool  operator!= (const iteratorBase &) const
const_iterator &  operator= (const iteratorBase &)
 Assign from iteratorBase or derived.
unsigned int  operator* () const
 Return referenced value directly.
unsigned int  operator() () const
 Return referenced value directly.
const_iterator &  operator++ ()
const_iterator  operator++ (int)
const_iterator &  operator-- ()
const_iterator  operator-- (int)

Constructor & Destructor Documentation

const_iterator (  ) [inline]

Construct null.

Definition at line 244 of file PackedListI.H.

const_iterator ( const iteratorBase &   iter  ) [inline]

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

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

Definition at line 269 of file PackedListI.H.

const_iterator ( const PackedList *   ,
const   label  
) [inline]

Construct from base list and position index.

const_iterator ( const iterator &   iter  ) [inline]

Construct from iterator.

Definition at line 308 of file PackedListI.H.


Member Function Documentation

bool operator== ( const iteratorBase &   iter  ) const [inline]

Compare positions (not values)

Reimplemented from PackedList< nBits >::iteratorBase.

Definition at line 339 of file PackedListI.H.

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

bool operator!= ( const iteratorBase &   iter  ) const [inline]

Reimplemented from PackedList< nBits >::iteratorBase.

Definition at line 349 of file PackedListI.H.

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

Foam::PackedList< nBits >::const_iterator & operator= ( const iteratorBase &   iter  ) [inline]

Assign from iteratorBase or derived.

eg, iter = packedlist[i] or even iter = list.begin()

Reimplemented from PackedList< nBits >::iteratorBase.

Definition at line 378 of file PackedListI.H.

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

unsigned int operator* (  ) const [inline]

Return referenced value directly.

Definition at line 488 of file PackedListI.H.

unsigned int operator() (  ) const [inline]

Return referenced value directly.

Definition at line 496 of file PackedListI.H.

Foam::PackedList< nBits >::const_iterator & operator++ (  ) [inline]

Definition at line 405 of file PackedListI.H.

Foam::PackedList< nBits >::const_iterator operator++ ( int    ) [inline]

Definition at line 424 of file PackedListI.H.

Foam::PackedList< nBits >::const_iterator & operator-- (  ) [inline]

Definition at line 443 of file PackedListI.H.

Foam::PackedList< nBits >::const_iterator operator-- ( int    ) [inline]

Definition at line 462 of file PackedListI.H.


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