Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
 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 ( PhysicalModel pml,
std::string  targetList 
)

constructor

AtomIterator::~AtomIterator ( )

destructor

Member Function Documentation

void AtomIterator::begin ( )

place iterator on first atom

Atom* AtomIterator::currentAtom ( )

return current atom

bool AtomIterator::end ( )

return true if iterator is over the last atom

void AtomIterator::next ( )

if iteration is not finished, advance to next atom

void AtomIterator::operator++ ( )

redefinition of ++ operator, advance iterator to next atom

Member Data Documentation

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

atoms list

unsigned int AtomIterator::index
private

current atom index


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