AtomsetIterator

All Known Subinterfaces:

AtomIterator, AtomIteratorAtomDependent, AtomIteratorBasisDependent, AtomIteratorBoxDependent, AtomLeafsetIterator, AtomsetIteratorBasisDependent, AtomsetIteratorBoxDependent, AtomsetIteratorDirectable, AtomsetIteratorPDT, AtomsetIteratorTargetable, MoleculeIterator, MoleculeIteratorBoxDependent, MoleculeIteratorMoleculeDependent, MoleculesetIterator, MoleculesetIteratorBasisDependent, MoleculesetIteratorBoxDependent, MoleculesetIteratorPDT, MoleculesetIteratorTargetable

All Known Implementing Classes:

ANIntergroupCoupled, ANIntergroupExchange, ANIntragroupExchange, Api1ACell, Api1ASite, ApiFilteredCylinder, ApiIndexList, ApiInnerVariable, ApiInterArrayList, ApiIntergroup, ApiIntergroupCoupled, ApiIntergroupExchange, ApiIntergroupIntraSpecies, ApiIntraArrayList, ApiIntragroup, ApiLeafAtoms, AtomIteratorArrayList, AtomIteratorArrayListAdjacent, AtomIteratorArrayListSimple, AtomIteratorBasis, AtomIteratorBasisAdjustableStart, AtomIteratorBasisFilteredType, AtomIteratorBasisFilteredType2, AtomIteratorLeafAtoms, AtomIteratorLeafFilteredType, AtomIteratorNull, AtomIteratorSinglet, Atomset3IteratorIndexList, Atomset4IteratorIndexList, AtomsetIteratorAllLeafAtoms, MCMoveInsertDeleteLatticeVacancy.AtomIteratorBruteForce, MCMoveInsertDeleteLatticeVacancy.AtomIteratorNbr, MCMoveInsertDeleteLatticeVacancy.AtomIteratorNbrCell, MoleculeIteratorAll, MoleculeIteratorAllMolecules, MoleculeIteratorArrayList, MoleculeIteratorArrayListSimple, MoleculeIteratorMolecule, MoleculeIteratorSinglet, Mpi1ACell, MpiInnerFixed, MpiInnerVariable, MpiInterArrayList, MpiInterspecies1A, MpiInterspeciesAA, MpiIntraArrayList, MpiIntraspecies1A, MpiIntraspeciesAA, MpiMolecule, PotentialMaster.AtomIterator0, PotentialMaster.MoleculeIterator0
```
public interface AtomsetIterator
```
Interface for classes that loop over a set of atoms. Permits iteration via a next()!=null while loop (iterator returns atoms to client) or via a call to allAtoms(AtomsetActive) (client gives action to iterator).

Method Summary

All Methods Instance Methods Abstract Methods
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().
`void`	`reset()`	Resets the iterator to loop through its iterates again.
`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.

- Method Detail
  - reset
```
void reset()
```
    Resets the iterator to loop through its iterates again.
  - unset
```
void unset()
```
    Puts iterator in a state in which hasNext() returns false.
  - size
```
int size()
```
    The number of iterates returned by this iterator in its current state.
  - nBody
```
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().
    
    Returns:

Interface AtomsetIterator

Method Summary

Method Detail

reset

unset

size

nBody