Package etomica.species

Class SpeciesAgentManager<E>

java.lang.Object

etomica.species.SpeciesAgentManager<E>

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

AtomTypeAgentManager acts on behalf of client classes (an AgentSource) to manage agents in every AtomType in a box. When species are added or removed from the simulation, the agents array (indexed by the AtomType's global index) is updated. The client should call getAgents() at any point where an atom might have have been added to the system because the old array would be stale at that point.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	dispose()	Unregisters this class as a listener for AtomType-related events and releases its agents.
E	getAgent(ISpecies species)	Convenience method to return the agent the given AtomType.
IndexMap<E>	getAgents()
void	setAgent(ISpecies species, 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

Constructor Detail

SpeciesAgentManager

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

Method Detail

getAgents

public IndexMap<E> getAgents()

setAgent

public void setAgent(ISpecies species,
                     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(ISpecies species)

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()

Unregisters this class as a listener for AtomType-related events and releases its agents.