uk.ac.soton.simulation.jsit.anylogic

Class AnyLogicLoggerAccessor

java.lang.Object

uk.ac.soton.simulation.jsit.anylogic.AnyLogicLoggerAccessor

All Implemented Interfaces:

java.io.Serializable

public class AnyLogicLoggerAccessor
extends java.lang.Object
implements java.io.Serializable

Logger accessor specifically for AnyLogic. This allows for the use of AnyLogicLogger Loggers (which work around AnyLogic threading issues), where the logger is 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.)

Since:

0.2

Author:

Stuart Rossiter

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AnyLogicLoggerAccessor(java.lang.Class<?> owner) Create an 'empty' accessor.

Method Summary

Modifier and Type	Method and Description
void	addLoggerForRun(com.anylogic.engine.Agent agentInModel) Thread-safe method to add a logger for the current run.
static AnyLogicLogger	getAccessorFreeAnyLogicLogger(java.lang.Class<?> owner, com.anylogic.engine.Agent agentInModel) Get an AnyLogicLogger without an associated AnyLogicLoggerAccessor.
AnyLogicLogger	getLoggerForRun(com.anylogic.engine.Agent agentInModel) Thread-safe method to retrieve the logger for the current run.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnyLogicLoggerAccessor

public AnyLogicLoggerAccessor(java.lang.Class<?> owner)

Create an 'empty' accessor.

Parameters:

owner - The class which is owning (using) this accessor.

Since:

0.2

Method Detail

getAccessorFreeAnyLogicLogger

public static AnyLogicLogger getAccessorFreeAnyLogicLogger(java.lang.Class<?> owner,
                                                           com.anylogic.engine.Agent agentInModel)

Get an AnyLogicLogger without an associated AnyLogicLoggerAccessor. This should only be used when you have singleton model classes (and thus want to store the logger in the instance, not statically, and thus don't need an accessor) or when you are sure that your model will never be run in a multi-run AnyLogic experiment with parallel instances. It is always safer to use a (static) AnyLogicLoggerAccessor instance instead.

Parameters:

owner - The class which owns (is using) the logger.

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 appropriate AnyLogicLogger for this class (which wraps the appropriate Logback Logger and provides the same interface, plus the ensureExternalLoggingForBlock method.

Since:

0.2

addLoggerForRun

public void addLoggerForRun(com.anylogic.engine.Agent agentInModel)

Thread-safe method to add a logger 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.

Since:

0.2

getLoggerForRun

public AnyLogicLogger getLoggerForRun(com.anylogic.engine.Agent agentInModel)

Thread-safe method to retrieve the logger for the current run. This will fail if one was not added.

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 relevant logger for this agent.

Since:

0.2