ikr.simlib.control

Class SimTreeApplication

java.lang.Object

ikr.simlib.control.SimTreeApplication

public abstract class SimTreeApplication
extends java.lang.Object

Base class for SimTree applications. Applications derived from this class support the following command line arguments:

-s seed

Seed index for the system RNG

-n numberOfBatches

The number of batches to run. If 0, the simulation is not run at all.

-p par

Parameter file (default: sim.par)

-f fmt

Format file

-l log

Result file (default: sim.log). If the log file is none, no results are written.

-b batchLog(s)

Batch result files. If only one argument is given and is equal to default, the default batch logs are created.

-e exportLog(s)

Export result files. If only one argument is given and is equal to default, the default export logs are created.

-i importLog(s)

Import result files.

-g parseLog

Log file for the parser

-t testLog

Test result file

-z compression type

Valid compression types are "bzip2", "lzma", or "gzip". The default behavior is to not compress files.

-c calendar type

Valid calendar types are "fast", "std", or "simple". The default calendar is the "fast calendar".

A typical application may be started like this:

 public static void main(String[] args) {
    SimTreeApplication app = new MyApp(args);
 
    app.run();
 }
 

Applications have to implement the createModel method to provide the simulation model. Further control over the application components is given to deriving classes by the createCalendar, createSystemRNG and createSimulation methods, which have sensible default implementations.

The constructor might exit the VM with System.exit to be compatible to the SimTree semantics.

The SimTreeApplication can also be executed directly from the command line. It requires the class name of the model as first argument. The model constructor must look like this:

 MyModel(ParseEnvrionment env)
 

See Also:

SimulationEnvironment

Field Summary

Fields

Modifier and Type	Field and Description
protected Model	model Simulation model.
protected SimulationEnvironment	simEnvironment Simulation environment for the default simulations.
protected Simulation	simulation The simulation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimTreeApplication() Creates a new SimTree application.
protected	SimTreeApplication(java.lang.String name, java.lang.String[] args) Creates a new SimTree application.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	createCalendar(java.lang.String name) Creates the calendar for the simulation.
protected Simulation	createImportSimulation() Creates the import simulation.
protected abstract Model	createModel(Parameters pars) Creates the model for the simulation.
protected Simulation	createSimulation() Creates the simulation.
protected RandomNumberGenerator	createSystemRNG() Creates the system RNG.
protected void	init(java.lang.String name, java.lang.String[] args) Parses the arguments and creates the simulation environment.
void	run() Runs the simulation.

Methods inherited from class java.lang.Object

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

Field Detail

simEnvironment

protected SimulationEnvironment simEnvironment

Simulation environment for the default simulations.

model

protected Model model

Simulation model.

simulation

protected Simulation simulation

The simulation. Depending on the command line arguments it is initialized by either createSimulation or createImportSimulation.

Constructor Detail

SimTreeApplication

protected SimTreeApplication()

Creates a new SimTree application. This constructor is solely used by deriving applications which have to call init themselves.

SimTreeApplication

protected SimTreeApplication(java.lang.String name,
                  java.lang.String[] args)

Creates a new SimTree application. This constructor might exit the VM with System.exit to adhere to the SimTree semantics.

Parameters:

name - of the SimTree application

args - command line arguments

Method Detail

init

protected void init(java.lang.String name,
        java.lang.String[] args)

Parses the arguments and creates the simulation environment. This method might exit the VM with System.exit to adhere to the SimTree semantics.

createModel

protected abstract Model createModel(Parameters pars)

Creates the model for the simulation. The calendar field is initialized before this method is called.

Parameters:

pars - an object representing the entire parameter tree

Returns:

the simulation model

createCalendar

protected void createCalendar(java.lang.String name)

Creates the calendar for the simulation.

createSystemRNG

protected RandomNumberGenerator createSystemRNG()

Creates the system RNG. By default a StdRandomNumberGenerator is returned.

Returns:

the system RNG

createSimulation

protected Simulation createSimulation()

Creates the simulation. By default a StdSimulation is returned.

createImportSimulation

protected Simulation createImportSimulation()

Creates the import simulation. By default a ImportSimulation is returned.

run

public void run()

Runs the simulation.