Package etomica.atom

Class AtomLeafAgentManager<E>

java.lang.Object

etomica.box.BoxEventListenerAdapter

etomica.atom.AtomLeafAgentManager<E>

All Implemented Interfaces:

BoxEventListener

public final class AtomLeafAgentManager<E>
extends BoxEventListenerAdapter

AtomAgentManager acts on behalf of client classes (an AgentSource) to manage agents for every leaf Atom in a box. When leaf atoms are added or removed from the box, the agents array (indexed by the atom's global index) is updated. The client can access and modify the agents via getAgent and setAgent.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Box	box

Constructor Summary

Constructors

Constructor	Description
AtomLeafAgentManager(AtomLeafAgentManager.AgentSource<E> source, Box box)
AtomLeafAgentManager(java.util.function.Function<IAtom,? extends E> agentSource, Box box)

Method Summary

Modifier and Type	Method	Description
void	boxAtomLeafIndexChanged(BoxAtomIndexEvent e)	Called when an atom's global (leaf) index has changed.
void	boxGlobalAtomLeafIndexChanged(BoxIndexEvent e)	Called when the maximum leaf index in the box has changed.
void	boxMoleculeAdded(BoxMoleculeEvent e)	Called when a molecule is added to the box.
void	boxMoleculeRemoved(BoxMoleculeEvent e)	Called when a molecule is removed from the box.
void	dispose()	Notifies the AtomAgentManager it should disconnect itself as a listener and release all of its agents.
E	getAgent(IAtom a)	Returns the agent associated with the given IAtom.
IndexMap<E>	getAgents()	Get the agents map.
Box	getBox()	Convenience method to return the box the Manager is tracking.
void	setAgent(IAtom a, E newAgent)	Sets the agent associated with the given atom to be the given agent.

Methods inherited from class etomica.box.BoxEventListenerAdapter

boxMoleculeIndexChanged, boxNumberMolecules

Methods inherited from class java.lang.Object

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

Field Detail

box

protected final Box box

Constructor Detail

AtomLeafAgentManager

public AtomLeafAgentManager(java.util.function.Function<IAtom,? extends E> agentSource,
                            Box box)

AtomLeafAgentManager

public AtomLeafAgentManager(AtomLeafAgentManager.AgentSource<E> source,
                            Box box)

Method Detail

getAgents

public IndexMap<E> getAgents()

Get the agents map. To iterate over all agents, iterate over the collection returned by agents.values().

Returns:

the map from atom leaf index to its agent

getAgent

public E getAgent(IAtom a)

Returns the agent associated with the given IAtom. The IAtom must be from the Box associated with this instance.

setAgent

public void setAgent(IAtom a,
                     E newAgent)

Sets the agent associated with the given atom to be the given agent. The IAtom must be from the Box associated with this instance. The IAtom's old agent is not released. This should be done manually if needed.

getBox

public Box getBox()

Convenience method to return the box the Manager is tracking.

dispose

public void dispose()

Notifies the AtomAgentManager it should disconnect itself as a listener and release all of its agents.

boxMoleculeAdded

public void boxMoleculeAdded(BoxMoleculeEvent e)

Description copied from interface: BoxEventListener

Called when a molecule is added to the box.

Specified by:

boxMoleculeAdded in interface BoxEventListener

Overrides:

boxMoleculeAdded in class BoxEventListenerAdapter

Parameters:

e - the event, which contains the added molecule and the box to which it was added.

boxMoleculeRemoved

public void boxMoleculeRemoved(BoxMoleculeEvent e)

Description copied from interface: BoxEventListener

Called when a molecule is removed from the box.

Specified by:

boxMoleculeRemoved in interface BoxEventListener

Overrides:

boxMoleculeRemoved in class BoxEventListenerAdapter

Parameters:

e - the event, which contains the removed molecule and the box from which it was removed.

boxGlobalAtomLeafIndexChanged

public void boxGlobalAtomLeafIndexChanged(BoxIndexEvent e)

Description copied from interface: BoxEventListener

Called when the maximum leaf index in the box has changed.

Specified by:

boxGlobalAtomLeafIndexChanged in interface BoxEventListener

Overrides:

boxGlobalAtomLeafIndexChanged in class BoxEventListenerAdapter

Parameters:

e - the event, which contains the box and the new maximum global index

boxAtomLeafIndexChanged

public void boxAtomLeafIndexChanged(BoxAtomIndexEvent e)

Description copied from interface: BoxEventListener

Called when an atom's global (leaf) index has changed. This typically happens after one molecule is removed and the indices of other atoms are renumbered to fill in the gap left by the removed atoms.

Specified by:

boxAtomLeafIndexChanged in interface BoxEventListener

Overrides:

boxAtomLeafIndexChanged in class BoxEventListenerAdapter

Parameters:

e - the event, which contains the box, the atom whose index changed and the atom's old leaf index. The atom's new leaf index can be obtained from the atom.