Package etomica.atom.iterator

Interface AtomsetIteratorTargetable

All Superinterfaces:

AtomLeafsetIterator, AtomsetIterator

All Known Subinterfaces:

AtomIteratorBasisDependent, AtomsetIteratorBasisDependent, AtomsetIteratorPDT

All Known Implementing Classes:

ANIntergroupCoupled, ANIntergroupExchange, ANIntragroupExchange, Api1ACell, Api1ASite, ApiIndexList, ApiIntergroup, ApiIntergroupCoupled, ApiIntergroupExchange, ApiIntergroupIntraSpecies, ApiIntragroup, AtomIteratorBasis, AtomIteratorBasisAdjustableStart, AtomIteratorBasisFilteredType, AtomIteratorBasisFilteredType2, Atomset3IteratorIndexList, Atomset4IteratorIndexList, AtomsetIteratorAllLeafAtoms, PotentialMaster.AtomIterator0

public interface AtomsetIteratorTargetable
extends AtomLeafsetIterator

Interface for an iterator that can be targeted at one or more atoms. Setting a target causes the iterator to produce only those of its iterates that contain the target atom(s). A typical use would be to set an atom as a target for a pair iterator, so the iterator would form only those pairs that contain the targeted atom. The argument can be null, indicating no target.

Method Summary

Modifier and Type	Method	Description
void	setTarget(IAtom targetAtom)

Methods inherited from interface etomica.atom.iterator.AtomLeafsetIterator

next

Methods inherited from interface etomica.atom.iterator.AtomsetIterator

nBody, reset, size, unset

Method Detail

setTarget

void setTarget(IAtom targetAtom)