uk.ac.soton.simulation.jsit.core

Class StandardStochasticAccessor<S extends AbstractStochasticItem>

java.lang.Object

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

uk.ac.soton.simulation.jsit.core.StandardStochasticAccessor<S>

All Implemented Interfaces:

java.io.Serializable

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

'Default' stochastic accessor using MDC keys---as Logback does--- to track stochastic items per run.

Since:

0.2

Author:

Stuart Rossiter

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StandardStochasticAccessor(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.

Method Summary

Modifier and Type	Method and Description
void	addForRun(S stochItem)
S	getForRun()
static void	registerAccessorFreeStochItem(java.lang.Class<?> owner, java.lang.String id, 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

StandardStochasticAccessor

public StandardStochasticAccessor(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.

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.1

Method Detail

registerAccessorFreeStochItem

public static void registerAccessorFreeStochItem(java.lang.Class<?> owner,
                                                 java.lang.String id,
                                                 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.

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

getForRun

public S getForRun()

removeMe

public void removeMe(AbstractStochasticItem stochItem)

Exposed for technical reasons; not for JSIT user use.

Specified by:

removeMe in class AbstractStochasticAccessInfo