Package etomica.box

Interface BoxEventListener

All Known Implementing Classes:

AtomLeafAgentManager, BoxEventListenerAdapter, IntegratorDroplet, IntegratorFixedWall, IntegratorGear4, IntegratorHard, IntegratorHardMDMC, IntegratorHardPiston, IntegratorHarmonic, IntegratorImageHarmonicMD, IntegratorImageMultistepMD, IntegratorMD, IntegratorMDHarmonicMC, IntegratorPolymer, IntegratorRigidIterative, IntegratorRigidMatrixIterative, IntegratorVelocityVerlet, IntegratorVelocityVerletQuaternion, IntegratorVelocityVerletRattle, IntegratorVelocityVerletSAM, IntegratorVelocityVerletShake, IntegratorVerlet, MoleculeAgentManager

public interface BoxEventListener

A box listener receives notifications for box events. Each type of event triggers a call to a different method. A listener receives event notifications once it is added to the box's event manager.

Method Summary

Modifier and Type	Method	Description
default void	boxAtomLeafIndexChanged(BoxAtomIndexEvent e)	Called when an atom's global (leaf) index has changed.
default void	boxGlobalAtomLeafIndexChanged(BoxIndexEvent e)	Called when the maximum leaf index in the box has changed.
default void	boxMoleculeAdded(BoxMoleculeEvent e)	Called when a molecule is added to the box.
default void	boxMoleculeIndexChanged(BoxMoleculeIndexEvent e)	Called when an molecule's index has changed.
default void	boxMoleculeRemoved(BoxMoleculeEvent e)	Called when a molecule is removed from the box.
default void	boxNumberMolecules(BoxMoleculeCountEvent e)	Called when the number of molecules of a particular species has changed in the box.

Method Detail

boxMoleculeAdded

default void boxMoleculeAdded(BoxMoleculeEvent e)

Called when a molecule is added to the box.

Parameters:

e - the event, which contains the added molecule and the box to which it was added.

boxMoleculeRemoved

default void boxMoleculeRemoved(BoxMoleculeEvent e)

Called when a molecule is removed from the box.

Parameters:

e - the event, which contains the removed molecule and the box from which it was removed.

boxGlobalAtomLeafIndexChanged

default void boxGlobalAtomLeafIndexChanged(BoxIndexEvent e)

Called when the maximum leaf index in the box has changed.

Parameters:

e - the event, which contains the box and the new maximum global index

boxAtomLeafIndexChanged

default void boxAtomLeafIndexChanged(BoxAtomIndexEvent e)

Called when an atom's global (leaf) index has changed. This typically happens after one molecule is removed and the indices of other atoms are renumbered to fill in the gap left by the removed atoms.

Parameters:

e - the event, which contains the box, the atom whose index changed and the atom's old leaf index. The atom's new leaf index can be obtained from the atom.

boxMoleculeIndexChanged

default void boxMoleculeIndexChanged(BoxMoleculeIndexEvent e)

Called when an molecule's index has changed. This typically happens after one molecule is removed and the indices of another molecule is changed to fill in the gap.

Parameters:

e - the event, which contains the box, the molecule whose index changed and the molecule's old index. The molecule's new index can be obtained from the atom.

boxNumberMolecules

default void boxNumberMolecules(BoxMoleculeCountEvent e)

Called when the number of molecules of a particular species has changed in the box. This method is called before the new molecules have been added to the box.

Parameters:

e - the event, which contains the box, the species and the new number of molecules of that species.