Package etomica.molecule.iterator

Class MoleculeIteratorAllMolecules

java.lang.Object

etomica.molecule.iterator.MoleculeIteratorArrayListSimple

etomica.molecule.iterator.MoleculeIteratorAllMolecules

All Implemented Interfaces:

AtomsetIterator, MoleculeIterator, MoleculeIteratorBoxDependent, MoleculesetIterator, MoleculesetIteratorBoxDependent

public class MoleculeIteratorAllMolecules
extends MoleculeIteratorArrayListSimple
implements MoleculeIteratorBoxDependent

Iterator for all the molecules in a box. Loops over all those atoms that lie just below the species agents in the atom tree hierarchy. To iterate the molecules of just one species, use AtomIteratorMolecule.

Since:

02.02.16

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.molecule.iterator.MoleculeIteratorArrayListSimple

atomSetSinglet, cursor, list

Constructor Summary

Constructors

Constructor	Description
MoleculeIteratorAllMolecules()
MoleculeIteratorAllMolecules(Box box)	Returns a new iterator ready to iterate over the molecules of the given box.

Method Summary

Modifier and Type	Method	Description
void	setBox(Box box)	Sets the box having the molecules to be returned as iterates.

Methods inherited from interface etomica.atom.iterator.AtomsetIterator

nBody, reset, size, unset

Methods inherited from interface etomica.molecule.iterator.MoleculeIterator

nextMolecule

Methods inherited from class etomica.molecule.iterator.MoleculeIteratorArrayListSimple

nBody, next, nextMolecule, reset, setList, size, unset

Methods inherited from interface etomica.molecule.iterator.MoleculesetIterator

next

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MoleculeIteratorAllMolecules

public MoleculeIteratorAllMolecules()

MoleculeIteratorAllMolecules

public MoleculeIteratorAllMolecules(Box box)

Returns a new iterator ready to iterate over the molecules of the given box.

Method Detail

setBox

public void setBox(Box box)

Sets the box having the molecules to be returned as iterates.

Specified by:

setBox in interface MoleculesetIteratorBoxDependent