Computer Assited Medical Intervention Tool Kit  version 4.1
Public Member Functions | Private Attributes | List of all members
AtomIterator Class Reference

Allow iteration over a set of atoms given by a target list (component name or index list) More...

#include <AtomIterator.h>

Public Member Functions

 AtomIterator (PhysicalModel *pml, std::string targetList)
 constructor More...
 
void begin ()
 place iterator on first atom More...
 
AtomcurrentAtom ()
 return current atom More...
 
bool end ()
 return true if iterator is over the last atom More...
 
void next ()
 if iteration is not finished, advance to next atom More...
 
void operator++ ()
 redefinition of ++ operator, advance iterator to next atom More...
 
 ~AtomIterator ()=default
 destructor More...
 

Private Attributes

std::vector< Atom * > atoms
 atoms list More...
 
unsigned int index
 current atom index More...
 

Detailed Description

Allow iteration over a set of atoms given by a target list (component name or index list)

Constructor & Destructor Documentation

◆ AtomIterator()

AtomIterator::AtomIterator ( PhysicalModel pml,
std::string  targetList 
)

◆ ~AtomIterator()

AtomIterator::~AtomIterator ( )
default

destructor

Member Function Documentation

◆ begin()

void AtomIterator::begin ( )

◆ currentAtom()

Atom * AtomIterator::currentAtom ( )

◆ end()

bool AtomIterator::end ( )

◆ next()

void AtomIterator::next ( )

◆ operator++()

void AtomIterator::operator++ ( )

redefinition of ++ operator, advance iterator to next atom

References end(), and index.

Member Data Documentation

◆ atoms

std::vector<Atom*> AtomIterator::atoms
private

atoms list

Referenced by AtomIterator(), currentAtom(), and end().

◆ index

unsigned int AtomIterator::index
private

current atom index

Referenced by AtomIterator(), begin(), currentAtom(), end(), next(), and operator++().


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