Package etomica.molecule.iterator

Interface MoleculeIterator

All Superinterfaces:

AtomsetIterator, MoleculesetIterator

All Known Subinterfaces:

MoleculeIteratorBoxDependent, MoleculeIteratorMoleculeDependent

All Known Implementing Classes:

MoleculeIteratorAllMolecules, MoleculeIteratorArrayList, MoleculeIteratorArrayListSimple, MoleculeIteratorMolecule, MoleculeIteratorSinglet

public interface MoleculeIterator
extends MoleculesetIterator

Interface for classes that loop over a set of atoms. Permits iteration via a hasNext()-next() while loop (iterator returns atoms to client) or via a call to allAtoms(AtomActive) (client gives action to iterator).

Method Summary

Modifier and Type	Method	Description
IMolecule	nextMolecule()	Returns the next atom in the iteration sequence, or null if hasNext() is false.

Methods inherited from interface etomica.atom.iterator.AtomsetIterator

nBody, reset, size, unset

Methods inherited from interface etomica.molecule.iterator.MoleculesetIterator

next

Method Detail

nextMolecule

IMolecule nextMolecule()

Returns the next atom in the iteration sequence, or null if hasNext() is false.