PackedList::iteratorBase Class Reference

The iterator base for PackedList. More...

Inheritance diagram for PackedList::iteratorBase:

Collaboration diagram for PackedList::iteratorBase:

Public Member Functions
label	key () const
	Return the element index corresponding to the iterator. More...
bool	writeIfSet (Ostream &) const
	Write index/value for a non-zero entry. More...
bool	operator== (const iteratorBase &) const
	Compare values (not positions) More...
bool	operator!= (const iteratorBase &) const
unsigned int	operator= (const iteratorBase &)
	Assign value, not position. More...
unsigned int	operator= (const unsigned int val)
	Assign value. More...
	operator unsigned int () const
	Conversion operator. More...
Ostream &	printInfo (Ostream &) const
	Print information and values. More...
bool	writeIfSet (Ostream &os) const

Protected Member Functions
unsigned int	get () const
	Get value as unsigned, no range-checking. More...
bool	set (unsigned int)
	Set value, returning true if changed, no range-checking. More...
	iteratorBase ()
	Construct null. More...
	iteratorBase (const PackedList *, const label)
	Construct from base list and position index. More...

Protected Attributes
PackedList *	list_
	Pointer to original list. More...
label	index_
	Element index. More...

Friends
class	PackedList

Detailed Description

The iterator base for PackedList.

Note: data and functions are protected, to allow reuse by iterator and prevent most external usage.

Definition at line 417 of file PackedList.H.

Constructor & Destructor Documentation

iteratorBase() [1/2]

iteratorBase ( )

inlineprotected

Construct null.

Definition at line 272 of file PackedListI.H.

iteratorBase() [2/2]

iteratorBase ( const PackedList *  , const  label  )

inlineprotected

Construct from base list and position index.

Member Function Documentation

get()

unsigned int get ( ) const

inlineprotected

Get value as unsigned, no range-checking.

Definition at line 293 of file PackedListI.H.

References PackedList::max_value(), and PackedList::packing().

Here is the call graph for this function:

set()

bool set ( unsigned int  val )

inlineprotected

Set value, returning true if changed, no range-checking.

Definition at line 305 of file PackedListI.H.

References PackedList::max_value(), and PackedList::packing().

Here is the call graph for this function:

key()

Foam::label key ( ) const

inline

Return the element index corresponding to the iterator.

Definition at line 332 of file PackedListI.H.

writeIfSet() [1/2]

bool writeIfSet ( Ostream &  ) const

inline

Write index/value for a non-zero entry.

The bool specialization writes the index only

operator==()

bool operator== ( const iteratorBase &  iter ) const

inline

Compare values (not positions)

Definition at line 340 of file PackedListI.H.

References PackedList::get().

Here is the call graph for this function:

operator!=()

bool operator!= ( const iteratorBase &  iter ) const

inline

Definition at line 350 of file PackedListI.H.

References PackedList::get().

Here is the call graph for this function:

operator=() [1/2]

unsigned int operator= ( const iteratorBase &  )

inline

Assign value, not position.

This allows packed[0] = packed[3] for assigning values

operator=() [2/2]

unsigned int operator= ( const unsigned int  val )

inline

Assign value.

A non-existent entry will be auto-vivified.

Definition at line 370 of file PackedListI.H.

References PackedList::set().

Here is the call graph for this function:

operator unsigned int()

operator unsigned int ( ) const

inline

Conversion operator.

Never auto-vivify entries.

Definition at line 385 of file PackedListI.H.

References PackedList::get().

Here is the call graph for this function:

printInfo()

Foam::Ostream & printInfo

(

Ostream &

os

)

const

Print information and values.

Definition at line 149 of file PackedList.C.

References Foam::nl.

Referenced by main().

Here is the caller graph for this function:

writeIfSet() [2/2]

bool writeIfSet ( Ostream &  os ) const

inline

Definition at line 87 of file PackedListI.H.

Friends And Related Function Documentation

PackedList

friend class PackedList

friend

Definition at line 419 of file PackedList.H.

Field Documentation

list_

PackedList* list_

protected

Pointer to original list.

This also lets us use the default bitwise copy/assignment

Definition at line 427 of file PackedList.H.

Referenced by PackedList::const_iterator::operator=().

index_

label index_

protected

Element index.

Definition at line 430 of file PackedList.H.

Referenced by PackedList::const_iterator::operator=().

---

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

• src/OpenFOAM/containers/Lists/PackedList/PackedList.H
• src/OpenFOAM/containers/Lists/PackedList/PackedList.C
• src/OpenFOAM/containers/Lists/PackedList/PackedListI.H