Package etomica.box

Class BoxMoleculeEvent

java.lang.Object

etomica.box.BoxEvent

etomica.box.BoxMoleculeEvent

Direct Known Subclasses:

BoxMoleculeIndexEvent

public class BoxMoleculeEvent
extends BoxEvent

A box event that is somehow related to a molecule. The molecule might have been added or removed, or may have a new index. Details may be determined from the other interfaces implemented by the event object or obtained from calling methods from those interfaces.

Field Summary

Fields

Modifier and Type	Field	Description
protected IMolecule	molecule

Fields inherited from class etomica.box.BoxEvent

box

Constructor Summary

Constructors

Constructor	Description
BoxMoleculeEvent(Box box, IMolecule mole)

Method Summary

Modifier and Type	Method	Description
IMolecule	getMolecule()

Methods inherited from class etomica.box.BoxEvent

getBox

Methods inherited from class java.lang.Object

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

Field Detail

molecule

protected IMolecule molecule

Constructor Detail

BoxMoleculeEvent

public BoxMoleculeEvent(Box box,
                        IMolecule mole)

Method Detail

getMolecule

public IMolecule getMolecule()

Returns:

the molecule that is related to this event.