uk.ac.soton.simulation.jsit.anylogic

Class StochasticAccessorAnyLogic<S extends AbstractStochasticItem>

java.lang.Object

uk.ac.soton.simulation.jsit.core.AbstractStochasticAccessInfo

uk.ac.soton.simulation.jsit.anylogic.StochasticAccessorAnyLogic<S>

All Implemented Interfaces:

java.io.Serializable

public class StochasticAccessorAnyLogic<S extends AbstractStochasticItem>
extends AbstractStochasticAccessInfo
implements java.io.Serializable

This allows for the use of stochastic items that are shared between instances of some class (e.g., an AnyLogic Agent) that are for the same model run. (When using parallel runs of multi-run experiments, you will have instances of model classes for all parallel runs 'mixed together' in a single JVM.)

This is an AnyLogic-specific variant of the standard version which works round AnyLogic threading issues (and should always be used for AnyLogic models).

Since:

0.2

Author:

Stuart Rossiter

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StochasticAccessorAnyLogic(java.lang.Class<?> owner, java.lang.String id) Create an 'empty' accessor, normally held statically to access the per-run stochastic item across all instances of the class (in a way that works around AnyLogic threading issues).

Method Summary

Modifier and Type	Method and Description
void	addForRun(com.anylogic.engine.Agent agentInModel, S stochItem) Thread-safe method to add a stochastic item for the current run.
S	getForRun(com.anylogic.engine.Agent agentInModel) Thread-safe method to get the stochastic item for the current run.
static void	registerAccessorFreeStochItem(java.lang.Class<?> owner, java.lang.String id, com.anylogic.engine.Agent agentInModel, AbstractStochasticItem stochItem) Register a stochastic item for use without an accessor for access.
void	removeMe(AbstractStochasticItem stochItem) Exposed for technical reasons; not for JSIT user use.

Methods inherited from class uk.ac.soton.simulation.jsit.core.AbstractStochasticAccessInfo

getFullID, getOwnerName

Methods inherited from class java.lang.Object

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

Constructor Detail

StochasticAccessorAnyLogic

public StochasticAccessorAnyLogic(java.lang.Class<?> owner,
                                  java.lang.String id)

Create an 'empty' accessor, normally held statically to access the per-run stochastic item across all instances of the class (in a way that works around AnyLogic threading issues).

Parameters:

owner - The class owning (using) the stochastic item.

id - A user-provided ID to define this stochastic item (used in stochastic control configuration files together with the owning class name).

Since:

0.2

Method Detail

registerAccessorFreeStochItem

public static void registerAccessorFreeStochItem(java.lang.Class<?> owner,
                                                 java.lang.String id,
                                                 com.anylogic.engine.Agent agentInModel,
                                                 AbstractStochasticItem stochItem)

Register a stochastic item for use without an accessor for access. This should only be done when using the item with singleton model classes (where it does not have to be shared between instances), and holding it as an instance field (i.e., not statically).

Parameters:

owner - The class owning (using) the stochastic item.

agentInModel - Any Agent instance that is part of the model. This method will actually search for the closest 'parent' MainModel_AnyLogic instance, so passing that (if available directly) will speed up the call.

id - A user-provided ID to define this stochastic item (used in stochastic control configuration files together with the owning class name).

stochItem - The stochastic item to register.

Since:

0.2

addForRun

public void addForRun(com.anylogic.engine.Agent agentInModel,
                      S stochItem)

Thread-safe method to add a stochastic item for the current run. This should only ever be called once per run.

Parameters:

agentInModel - Any Agent instance that is part of the model. This method will actually search for the closest 'parent' MainModel_AnyLogic instance, so passing that (if available directly) will speed up the call.

stochItem - The stochastic item being added.

Since:

0.2

getForRun

public S getForRun(com.anylogic.engine.Agent agentInModel)

Thread-safe method to get the stochastic item for the current run.

Parameters:

agentInModel - Any Agent instance that is part of the model. This method will actually search for the closest 'parent' MainModel_AnyLogic instance, so passing that (if available directly) will speed up the call.

Returns:

The stochastic item for the run.

Since:

0.2

removeMe

public void removeMe(AbstractStochasticItem stochItem)

Exposed for technical reasons; not for JSIT user use.

Specified by:

removeMe in class AbstractStochasticAccessInfo