Package etomica.association

Interface IAssociationHelper

All Known Implementing Classes:

AssociationHelperBranched, AssociationHelperDouble, AssociationHelperSingle

public interface IAssociationHelper

Interface for a class that is capable of populating a list of atoms in an smer as well as checking the validity of the bonding

Method Summary

Modifier and Type	Method	Description
boolean	populateList(AtomArrayList smerList, IAtom atom, boolean mightBeBroken)	Populates smerList with all atoms in the smer that contains atom.

Method Detail

populateList

boolean populateList(AtomArrayList smerList,
                     IAtom atom,
                     boolean mightBeBroken)

Populates smerList with all atoms in the smer that contains atom. If mightBeBroken is false, an exception is throw if any invalid bonding is encountered (along with potentially useful information about the invalid bonding). If mightBeBroken is true, then populateList returns true if any invalid bonding is encountered. populateList returns false if invalid bonding is not encountered.