Package etomica.box

Class BoxEventListenerAdapter

java.lang.Object

etomica.box.BoxEventListenerAdapter

All Implemented Interfaces:

BoxEventListener

Direct Known Subclasses:

AtomLeafAgentManager

public class BoxEventListenerAdapter
extends java.lang.Object
implements BoxEventListener

Constructor Summary

Constructors

Constructor	Description
BoxEventListenerAdapter()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxEventListenerAdapter

public BoxEventListenerAdapter()

Method Detail

boxMoleculeAdded

public void boxMoleculeAdded(BoxMoleculeEvent e)

Description copied from interface: BoxEventListener

Called when a molecule is added to the box.

Specified by:

boxMoleculeAdded in interface BoxEventListener

Parameters:

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

boxMoleculeRemoved

public void boxMoleculeRemoved(BoxMoleculeEvent e)

Description copied from interface: BoxEventListener

Called when a molecule is removed from the box.

Specified by:

boxMoleculeRemoved in interface BoxEventListener

Parameters:

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

boxGlobalAtomLeafIndexChanged

public void boxGlobalAtomLeafIndexChanged(BoxIndexEvent e)

Description copied from interface: BoxEventListener

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

Specified by:

boxGlobalAtomLeafIndexChanged in interface BoxEventListener

Parameters:

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

boxAtomLeafIndexChanged

public void boxAtomLeafIndexChanged(BoxAtomIndexEvent e)

Description copied from interface: BoxEventListener

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.

Specified by:

boxAtomLeafIndexChanged in interface BoxEventListener

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

public void boxMoleculeIndexChanged(BoxMoleculeIndexEvent e)

Description copied from interface: BoxEventListener

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.

Specified by:

boxMoleculeIndexChanged in interface BoxEventListener

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

public void boxNumberMolecules(BoxMoleculeCountEvent e)

Description copied from interface: BoxEventListener

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.

Specified by:

boxNumberMolecules in interface BoxEventListener

Parameters:

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