sim.engine

Class ZmtSimState

java.lang.Object

sim.engine.SimState

sim.engine.ZmtSimState

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BaseZmtSimState

public abstract class ZmtSimState
extends SimState

SimStates which can be automated need to extend this class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Path	DEFAULT_INPUT_DIR Default directory for loading the parameters from.
static Path	DEFAULT_OUTPUT_DIR Default directory to write simulation output.

Fields inherited from class sim.engine.SimState

random, schedule

Constructor Summary

Constructors

Constructor and Description
ZmtSimState(long seed)

Method Summary

Modifier and Type	Method and Description
String	createStatusMessage(double stepRatePerS) Creates a message to inform about the current status of the running simulation.
void	finish()
Optional<? extends Output>	getOutput() Gets the output object of this simulation.
abstract SimParams	getParams() Returns the SimParams object with the current configuration.
abstract Class<? extends SimParams>	getParamsClass() Returns the SimParams class used by this simulation.
void	setOutputPath(Path outputPath) Sets the path to write simulation output.
abstract void	setParams(SimParams params) Sets the current configuration to the given SimParams object.

Methods inherited from class sim.engine.SimState

addToAsynchronousRegistry, asynchronousRegistry, awakeFromCheckpoint, doLoop, doLoop, job, kill, nameThread, postCheckpoint, preCheckpoint, primeGenerator, printlnSynchronized, readFromCheckpoint, readFromCheckpoint, removeFromAsynchronousRegistry, seed, setJob, setSeed, start, version, writeToCheckpoint, writeToCheckpoint

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INPUT_DIR

public static final Path DEFAULT_INPUT_DIR

Default directory for loading the parameters from.

DEFAULT_OUTPUT_DIR

public static final Path DEFAULT_OUTPUT_DIR

Default directory to write simulation output.

Constructor Detail

ZmtSimState

public ZmtSimState(long seed)

Method Detail

createStatusMessage

public String createStatusMessage(double stepRatePerS)

Creates a message to inform about the current status of the running simulation. The default contains steps, time and rate. Can be called by the simulation runner. Child classes may override the method to create their own version.

Parameters:

stepRatePerS - the rate of steps per second measured by the simulation runner

Returns:

the created status message

getOutput

public Optional<? extends Output> getOutput()

Gets the output object of this simulation. Defaults to an empty Optional, can be overridden in sub classes. The returned object can be inspected in GUI if selected in menu.

Returns:

the output object of this simulation

setOutputPath

public void setOutputPath(Path outputPath)

Sets the path to write simulation output.

Parameters:

outputPath - the new output path

getParamsClass

public abstract Class<? extends SimParams> getParamsClass()

Returns the SimParams class used by this simulation. Implementing classes need to specify this in order to create and load suitable parameter objects.

XStream annotations are processed for this class and all which are referenced.

Returns:

the SimParams class used by this simulation

getParams

public abstract SimParams getParams()

Returns the SimParams object with the current configuration.

Returns:

the SimParams with the current configuration

setParams

public abstract void setParams(SimParams params)

Sets the current configuration to the given SimParams object.

Parameters:

params - the SimParams object containing the desired configuration

finish

public void finish()

Overrides:

finish in class SimState