Package etomica.box

Class BoxAgentManager<E>

java.lang.Object

etomica.box.BoxAgentManager<E>

All Implemented Interfaces:

SimulationListener

public final class BoxAgentManager<E>
extends java.lang.Object
implements SimulationListener

Acts on behalf of client classes (a BoxAgentSource) to manage agents for each Box in a simulation. When Box instances are added or removed from the simulation, the agents array (indexed by the Box's index) is updated.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BoxAgentManager.BoxAgentSource<E>	Interface for an object that makes an agent to be associated with each box upon construction.

Constructor Summary

Constructors

Constructor	Description
BoxAgentManager(BoxAgentManager.BoxAgentSource<E> source, Simulation sim)	Constructs and sets the Simulation containing Boxes to be tracked.
BoxAgentManager(Simulation sim, java.util.function.Function<Box,? extends E> source)
BoxAgentManager(Simulation sim, java.util.function.Function<Box,? extends E> source, java.util.function.Consumer<? super E> releaser)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Notifies the BoxAgentManager that it should release all agents and stop listening for events from the simulation.
E	getAgent(Box box)
IndexMap<E>	getAgents()
void	setAgent(Box box, E agent)	Associates an Agent with a Box.
void	simulationBoxAdded(Simulation sim, Box box)
void	simulationBoxRemoved(Simulation sim, Box box)

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxAgentManager

public BoxAgentManager(BoxAgentManager.BoxAgentSource<E> source,
                       Simulation sim)

Constructs and sets the Simulation containing Boxes to be tracked. This will register this BoxAgentManager as a listener to the Simulation so that it will be notified when Boxes are added or removed. This call also initializes the agents for any Boxes already existing in the Simulation.

Parameters:

source - object that makes the agents.

sim - the simulation using this BoxAgentManager

BoxAgentManager

public BoxAgentManager(Simulation sim,
                       java.util.function.Function<Box,? extends E> source)

BoxAgentManager

public BoxAgentManager(Simulation sim,
                       java.util.function.Function<Box,? extends E> source,
                       java.util.function.Consumer<? super E> releaser)

Method Detail

getAgents

public IndexMap<E> getAgents()

getAgent

public E getAgent(Box box)

Returns:

the agent associated with the given Box

setAgent

public void setAgent(Box box,
                     E agent)

Associates an Agent with a Box.

Parameters:

box - the Box

agent - the Agent

dispose

public void dispose()

Notifies the BoxAgentManager that it should release all agents and stop listening for events from the simulation.

simulationBoxAdded

public void simulationBoxAdded(Simulation sim,
                               Box box)

Specified by:

simulationBoxAdded in interface SimulationListener

simulationBoxRemoved

public void simulationBoxRemoved(Simulation sim,
                                 Box box)

Specified by:

simulationBoxRemoved in interface SimulationListener