Package etomica.atom

Class AtomTypeAgentManager<E>

java.lang.Object

etomica.atom.AtomTypeAgentManager<E>

public final class AtomTypeAgentManager<E>
extends java.lang.Object

AtomTypeAgentManager acts on behalf of client classes (an AgentSource) to manage agents for every AtomType in a box. When species are added or removed from the simulation, the agents map is updated.

This class should only be used instead of a Map when the SimulationListener functionality is required. That is, when the map needs to be kept up-to-date with every AtomType and an object provided by the AgentSource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AtomTypeAgentManager.AgentSource<E>	Interface for an object that wants an agent associated with each AtomType in a Simulation.

Field Summary

Fields

Modifier and Type	Field	Description
protected Simulation	sim

Constructor Summary

Constructors

Constructor	Description
AtomTypeAgentManager(AtomTypeAgentManager.AgentSource<E> source, Simulation sim)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Releases its agents.
E	getAgent(AtomType type)	Convenience method to return the agent the given AtomType.
IndexMap<E>	getAgents()
void	setAgent(AtomType atomType, E newAgent)	Sets the agent associated with the given atom type to be the given agent.

Methods inherited from class java.lang.Object

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

Field Detail

sim

protected Simulation sim

Constructor Detail

AtomTypeAgentManager

public AtomTypeAgentManager(AtomTypeAgentManager.AgentSource<E> source,
                            Simulation sim)

Method Detail

getAgents

public IndexMap<E> getAgents()

setAgent

public void setAgent(AtomType atomType,
                     E newAgent)

Sets the agent associated with the given atom type to be the given agent. The AtomType must be from the Simulation. The AtomType's old agent is not "released". This should be done manually if needed.

getAgent

public E getAgent(AtomType type)

Convenience method to return the agent the given AtomType. For repeated access to the agents from multiple AtomTypes, it might be faster to use the above getAgents method.

dispose

public void dispose()

Releases its agents.