Package etomica.modules.chainequilibrium

Class AtomTestChainLength

java.lang.Object

etomica.modules.chainequilibrium.AtomTestChainLength

All Implemented Interfaces:

AtomLeafAgentManager.AgentSource<AtomTestChainLength.LengthAgent>, AtomTest, AtomTestCollective, java.util.function.Predicate<IAtom>

public class AtomTestChainLength
extends java.lang.Object
implements AtomTestCollective, AtomLeafAgentManager.AgentSource<AtomTestChainLength.LengthAgent>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AtomTestChainLength.LengthAgent

Field Summary

Fields

Modifier and Type	Field	Description
protected AtomLeafAgentManager<IAtom[]>	agentManager
protected Box	box
protected AtomLeafAgentManager<AtomTestChainLength.LengthAgent>	chainLengthManager
protected int	maxChainLength

Constructor Summary

Constructors

Constructor	Description
AtomTestChainLength(AtomLeafAgentManager<IAtom[]> aam)

Method Summary

Modifier and Type	Method	Description
Box	getBox()
AtomTestChainLength.LengthAgent	makeAgent(IAtom a, Box agentBox)	Returns an agent for the given Atom.
protected int	recursiveTag(IAtom a, int chainLength)
void	releaseAgent(AtomTestChainLength.LengthAgent agent, IAtom atom, Box agentBox)	This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements.
void	resetTest()	Informs the AtomTest that something in the system has changed (atom positions, velocityies, etc) has changed and the status of the atoms should be determined.
void	setBox(Box box)
boolean	test(IAtom a)	Returns true if atom passes the test.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Field Detail

box

protected Box box

chainLengthManager

protected AtomLeafAgentManager<AtomTestChainLength.LengthAgent> chainLengthManager

agentManager

protected AtomLeafAgentManager<IAtom[]> agentManager

maxChainLength

protected int maxChainLength

Constructor Detail

AtomTestChainLength

public AtomTestChainLength(AtomLeafAgentManager<IAtom[]> aam)

Method Detail

makeAgent

public AtomTestChainLength.LengthAgent makeAgent(IAtom a,
                                                 Box agentBox)

Description copied from interface: AtomLeafAgentManager.AgentSource

Returns an agent for the given Atom. The agentBox is provided for convenience for agent sources that handle multiple boxes.

Specified by:

makeAgent in interface AtomLeafAgentManager.AgentSource<AtomTestChainLength.LengthAgent>

agentBox - TODO

releaseAgent

public void releaseAgent(AtomTestChainLength.LengthAgent agent,
                         IAtom atom,
                         Box agentBox)

Description copied from interface: AtomLeafAgentManager.AgentSource

This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements. The agentBox is provided for convenience for agent sources that handle multiple boxes.

Specified by:

releaseAgent in interface AtomLeafAgentManager.AgentSource<AtomTestChainLength.LengthAgent>

resetTest

public void resetTest()

Description copied from interface: AtomTestCollective

Informs the AtomTest that something in the system has changed (atom positions, velocityies, etc) has changed and the status of the atoms should be determined.

Specified by:

resetTest in interface AtomTestCollective

recursiveTag

protected int recursiveTag(IAtom a,
                           int chainLength)

getBox

public Box getBox()

setBox

public void setBox(Box box)

test

public boolean test(IAtom a)

Description copied from interface: AtomTest

Returns true if atom passes the test.

Specified by:

test in interface AtomTest

Specified by:

test in interface java.util.function.Predicate<IAtom>