jas.engine
Class MultiRun

java.lang.Object
  java.lang.Thread
      jas.engine.MultiRun

All Implemented Interfaces:

ISimEngineListener, java.lang.Runnable

public abstract class MultiRun
extends java.lang.Thread
implements ISimEngineListener

MultiRun is a template abstract class useful to guide the modeller to build an automatic simulation launcher, able to change interactively parameters on the basis of the last run.
The best way to understand hot it works is to see the MultiRun example in the JAS/examples directory.

The key methods of multi run are startModel() and nextModel(). The first one must create the simulation model(s), set its(their) parameters a vector containing them.
The jas engine will attach the returning list of model and execute the simulation. When the SIMULATION_END signal is sent to Sim.engine the multi run will execute the nextModel() method. Here user can observe the result of the last run and decide which parameters to use at next run. If method returns true another simulation run will be executed and the startModel() method will be called again, otherwise the progam will exit.

Title: JAS

Description: Java Agent-based Simulation library

Copyright: Copyright (C) 2002 Michele Sonnessa

Company:

Author:

Michele Sonnessa

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

MultiRun(java.lang.String title, int maxRuns)
Create a new multi run session.

Method Summary

void	go() The go method starts the multi-run simulation.
abstract boolean	nextModel() When a SIMULATION_END signal is sent to JAS by one of the running models, simulation is stopped and this method is called.
void	raisedEvent(int actionType) Implementing the ISimEngineListener.
void	run() MultiRun is an independent thread.
abstract ISimModel[]	startModel() This method is called each time a simulation is started.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiRun

public MultiRun(java.lang.String title,
                int maxRuns)

Create a new multi run session.

Parameters:

title - is the title of the multi run control panel (see MultiRunFrame API).

maxRuns - is the length of the progress bar. It is not so important. It has only a simbolic meaning.

Method Detail

go

public void go()

The go method starts the multi-run simulation.

nextModel

public abstract boolean nextModel()

When a SIMULATION_END signal is sent to JAS by one of the running models, simulation is stopped and this method is called. If it returns true the multi run will continue with the next run, otherwise the program will exit.

Returns:

a value deciding if simulation is to be continued.

raisedEvent

public void raisedEvent(int actionType)

Implementing the ISimEngineListener. This method monitors the Sim.EVENT_SIMULATION_END signal. When it is raised the MultiRun class shutdowns current run and invokes the nextModel() method.

Specified by:

raisedEvent in interface ISimEngineListener

Parameters:

actionType - a valid system eventID.

run

public void run()

MultiRun is an independent thread. The run method controls the sequence of simulations.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

startModel

public abstract ISimModel[] startModel()

This method is called each time a simulation is started. The modeller must override this method and specify which model to be instanced. Create one model or more, set their parameters, put them in a vector of ISimModel[] type and return them. The returning classes will be executed by JAS.

Returns:

the list of JAS simulation models to be executed.