Package etomica.atom

Class AtomSourceRandomSpecies

java.lang.Object

etomica.atom.AtomSourceRandomSpecies

All Implemented Interfaces:

AtomSource

public class AtomSourceRandomSpecies
extends java.lang.Object
implements AtomSource

AtomSource that returns a completely random leaf atom.

Field Summary

Fields

Modifier and Type	Field	Description
protected Box	box
protected IMoleculeList	list
protected IRandom	random
protected ISpecies	species

Constructor Summary

Constructors

Constructor	Description
AtomSourceRandomSpecies()
AtomSourceRandomSpecies(IRandom random, ISpecies s)

Method Summary

Modifier and Type	Method	Description
IAtom	getAtom()	returns a random atom from the box's leaf atom list
IRandom	getRandomNumberGenerator()	Returns the random number generator used to pick atoms
void	setBox(Box p)	sets the Box the source should pull Atoms from.
void	setRandomNumberGenerator(IRandom newRandom)	Sets the random number generator used to pick atoms
void	setSpecies(ISpecies s)

Methods inherited from class java.lang.Object

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

Field Detail

list

protected IMoleculeList list

random

protected IRandom random

box

protected Box box

species

protected ISpecies species

Constructor Detail

AtomSourceRandomSpecies

public AtomSourceRandomSpecies()

AtomSourceRandomSpecies

public AtomSourceRandomSpecies(IRandom random,
                               ISpecies s)

Method Detail

setRandomNumberGenerator

public void setRandomNumberGenerator(IRandom newRandom)

Sets the random number generator used to pick atoms

getRandomNumberGenerator

public IRandom getRandomNumberGenerator()

Returns the random number generator used to pick atoms

setSpecies

public void setSpecies(ISpecies s)

setBox

public void setBox(Box p)

Description copied from interface: AtomSource

sets the Box the source should pull Atoms from. Box should not be null

Specified by:

setBox in interface AtomSource

getAtom

public IAtom getAtom()

returns a random atom from the box's leaf atom list

Specified by:

getAtom in interface AtomSource