Package etomica.nbr.molecule

Class CriterionSpecies

java.lang.Object

etomica.nbr.molecule.CriterionAdapterMolecular

etomica.nbr.molecule.CriterionSpecies

All Implemented Interfaces:

NeighborCriterionMolecular

public class CriterionSpecies
extends CriterionAdapterMolecular

Filters molecule to match a given species.

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.nbr.molecule.CriterionAdapterMolecular

subCriterion

Constructor Summary

Constructors

Constructor	Description
CriterionSpecies(NeighborCriterionMolecular criterion, ISpecies species)

Method Summary

Modifier and Type	Method	Description
boolean	accept(IMoleculeList molecule)	Returns true if the species of the molecule matches the Species given at construction and if the wrapped criterion accept also returns true.
ISpecies	getSpecies()	Returns the Species accepted by this criterion.

Methods inherited from class etomica.nbr.molecule.CriterionAdapterMolecular

getWrappedCriterion, needUpdate, reset, setBox, unsafe

Methods inherited from class java.lang.Object

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

Constructor Detail

CriterionSpecies

public CriterionSpecies(NeighborCriterionMolecular criterion,
                        ISpecies species)

Method Detail

accept

public boolean accept(IMoleculeList molecule)

Returns true if the species of the molecule matches the Species given at construction and if the wrapped criterion accept also returns true.

Specified by:

accept in interface NeighborCriterionMolecular

Specified by:

accept in class CriterionAdapterMolecular

getSpecies

public ISpecies getSpecies()

Returns the Species accepted by this criterion.