uk.ac.soton.simulation.jsit.core

Interface MainModel

All Known Implementing Classes:

MainModel_AnyLogic

public interface MainModel

Interface that top-level JSIT-using model classes should implement to configure JSIT usage. Helper libraries will typically provide default implementations for these which the user should override if they need to.

Since:

0.1

Author:

Stuart Rossiter

Method Summary

Modifier and Type	Method and Description
void	doAllStaticStochRegistration() Called once during JSIT initialisation for the user to register any statically-held StochasticItem instances (i.e., ones not tied to specific instances of model components).
java.lang.String	getDiagnosticLogFormattedSimTime() Return the current simulation time formatted as desired for diagnostic log entries.
java.lang.String	getEventsLogFormattedSimTime() Return the current simulation time formatted as desired for events log entries.
java.lang.String	getInputsBasePath() Provide the relative path (from the runtime working directory) to where experiment inputs are kept.
java.lang.String	getOutputsBasePath() Provide the relative path (from the runtime working directory) to where experiment outputs are kept (in subfolders per run).
void	runSpecificEnvironmentSetup() Any run- or model-specific logic to perform at JSIT initialisation time (after all other JSIT initialisation has completed).

Method Detail

getInputsBasePath

java.lang.String getInputsBasePath()

Provide the relative path (from the runtime working directory) to where experiment inputs are kept.

Returns:

The relative path to the inputs folder (as a String).

Since:

0.1

getOutputsBasePath

java.lang.String getOutputsBasePath()

Provide the relative path (from the runtime working directory) to where experiment outputs are kept (in subfolders per run).

Returns:

The relative path to the outputs folder (as a String).

Since:

0.1

getDiagnosticLogFormattedSimTime

java.lang.String getDiagnosticLogFormattedSimTime()

Return the current simulation time formatted as desired for diagnostic log entries.

Returns:

The formatted simulation time (as a String).

Since:

0.1

getEventsLogFormattedSimTime

java.lang.String getEventsLogFormattedSimTime()

Return the current simulation time formatted as desired for events log entries.

Returns:

The formatted simulation time (as a String).

Since:

0.1

runSpecificEnvironmentSetup

void runSpecificEnvironmentSetup()

Any run- or model-specific logic to perform at JSIT initialisation time (after all other JSIT initialisation has completed).

Since:

0.1

doAllStaticStochRegistration

void doAllStaticStochRegistration()

Called once during JSIT initialisation for the user to register any statically-held StochasticItem instances (i.e., ones not tied to specific instances of model components). The user should override this method and perform the registrations as desired (e.g., 'globally' accessing all relevant classes or chaining down through the hierarchy of model components).

Since:

0.1