Package etomica.integrator.mcmove

Class MCMoveInsertDeleteLatticeVacancy.AtomIteratorNbrCell

java.lang.Object

etomica.integrator.mcmove.MCMoveInsertDeleteLatticeVacancy.AtomIteratorNbrCell

All Implemented Interfaces:

AtomIterator, AtomIteratorAtomDependent, AtomLeafsetIterator, AtomsetIterator, AtomsetIteratorDirectable

Enclosing class:

MCMoveInsertDeleteLatticeVacancy

public static class MCMoveInsertDeleteLatticeVacancy.AtomIteratorNbrCell
extends java.lang.Object
implements AtomIteratorAtomDependent, AtomsetIteratorDirectable

Field Summary

Fields

Modifier and Type	Field	Description
protected Api1ACell	api
protected IAtom	myAtom

Constructor Summary

Constructors

Constructor	Description
AtomIteratorNbrCell(double maxDistance, NeighborCellManager cellManager, Box box)

Method Summary

Modifier and Type	Method	Description
int	nBody()	Returns the number of atoms given in each iterate, i.e., the size of the atom array returned with each call to next().
IAtomList	next()	Returns the next AtomSet iterate, or null if hasNext() is false.
IAtom	nextAtom()	Returns the next atom in the iteration sequence, or null if hasNext() is false.
void	reset()	Resets the iterator to loop through its iterates again.
void	setAtom(IAtom atom)
void	setDirection(IteratorDirective.Direction direction)
int	size()	The number of iterates returned by this iterator in its current state.
void	unset()	Puts iterator in a state in which hasNext() returns false.

Methods inherited from class java.lang.Object

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

Field Detail

api

protected final Api1ACell api

myAtom

protected IAtom myAtom

Constructor Detail

AtomIteratorNbrCell

public AtomIteratorNbrCell(double maxDistance,
                           NeighborCellManager cellManager,
                           Box box)

Method Detail

nextAtom

public IAtom nextAtom()

Description copied from interface: AtomIterator

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

Specified by:

nextAtom in interface AtomIterator

next

public IAtomList next()

Description copied from interface: AtomLeafsetIterator

Returns the next AtomSet iterate, or null if hasNext() is false.

Specified by:

next in interface AtomLeafsetIterator

reset

public void reset()

Description copied from interface: AtomsetIterator

Resets the iterator to loop through its iterates again.

Specified by:

reset in interface AtomsetIterator

unset

public void unset()

Description copied from interface: AtomsetIterator

Puts iterator in a state in which hasNext() returns false.

Specified by:

unset in interface AtomsetIterator

size

public int size()

Description copied from interface: AtomsetIterator

The number of iterates returned by this iterator in its current state.

Specified by:

size in interface AtomsetIterator

nBody

public int nBody()

Description copied from interface: AtomsetIterator

Returns the number of atoms given in each iterate, i.e., the size of the atom array returned with each call to next().

Specified by:

nBody in interface AtomsetIterator

Returns:

setAtom

public void setAtom(IAtom atom)

Specified by:

setAtom in interface AtomIteratorAtomDependent

setDirection

public void setDirection(IteratorDirective.Direction direction)

Specified by:

setDirection in interface AtomsetIteratorDirectable