jas.engine
Class SimModel

java.lang.Object
  jas.engine.SimModel

All Implemented Interfaces:

ISimModel

public abstract class SimModel
extends java.lang.Object
implements ISimModel

This abstract class must be overridden by each simulation model. It gives the user some useful features. It keeps a reference to the event list, has got a list of statistic boxes, remember the SimModel's name.

To build a simulation model it is necessary to override two methods:
The method setParameters() is called by engine when the model is loaded into memory. It represent the phase of collecting parameters. If you want to prompt a windows to let the user modify some parameters, you have to put code in this method.
The method buildModel() is called when the user press the 'buildModels' button after setting the right simulation parameters. During this phase objects, actions and display widgets must be created. After that the simulation could start.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

Constructor Summary

SimModel()

Method Summary

void	addSimWindow(java.awt.Frame window) Call the engine addSimWindow() method.
void	addSimWindow(javax.swing.JInternalFrame window) Call the engine addSimWindow() method.
abstract void	buildModel() Build model, creating objects, schedule items and graphics.
void	dispose() Destroy some objects.
java.lang.String	getID() Return a string describing model.
java.lang.Class	getObjectClass(java.lang.Object object) Return the Class object representing the given object.
java.lang.Class	getObjectClass(java.lang.String className) Search into the JVM an instance of the class with the given name.
void	setEventList(EventList event_list) This method is used by engine to set the current event list.
void	setID(java.lang.String newID) Set the model's name.
abstract void	setParameters() Set simulation parameters before building model.
void	setPath(java.lang.String path) Set the path of this class.
void	simulationEnd() Do something at simulation end.
java.lang.String	toString() Return the string representing model.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimModel

public SimModel()

Method Detail

addSimWindow

public void addSimWindow(java.awt.Frame window)

Call the engine addSimWindow() method.

Specified by:

addSimWindow in interface ISimModel

Parameters:

window - The frame window to add to the engine's windowBag.

addSimWindow

public void addSimWindow(javax.swing.JInternalFrame window)

Call the engine addSimWindow() method.

Parameters:

window - The frame window to add to the engine's windowBag.

buildModel

public abstract void buildModel()

Build model, creating objects, schedule items and graphics.

Specified by:

buildModel in interface ISimModel

dispose

public void dispose()

Destroy some objects.

Specified by:

dispose in interface ISimModel

getID

public java.lang.String getID()

Return a string describing model. If not specified this method returns the string representing the object class name.

Specified by:

getID in interface ISimModel

Returns:

The string describing uniquely the model's instance.

getObjectClass

public java.lang.Class getObjectClass(java.lang.Object object)

Return the Class object representing the given object.

Parameters:

object - The object which class name is to be searched.

Returns:

The asked class. Null if not found.

getObjectClass

public java.lang.Class getObjectClass(java.lang.String className)

Search into the JVM an instance of the class with the given name.

Parameters:

className - The class name to search.

Returns:

The asked class. Null if not found.

setEventList

public void setEventList(EventList event_list)

This method is used by engine to set the current event list. It is used to synchronize the schedule of each running model.

Specified by:

setEventList in interface ISimModel

Parameters:

event_list - The event list used by engine.

setID

public void setID(java.lang.String newID)

Set the model's name. If you want to run in parallel more instances of the same model it is good to set different names to each instance.

Specified by:

setID in interface ISimModel

Parameters:

newID - A string describing uniquely the model's instance.

setParameters

public abstract void setParameters()

Set simulation parameters before building model.

Specified by:

setParameters in interface ISimModel

setPath

public void setPath(java.lang.String path)

Set the path of this class.

Specified by:

setPath in interface ISimModel

Parameters:

path - The string representing the class path.

simulationEnd

public void simulationEnd()

Do something at simulation end.

Specified by:

simulationEnd in interface ISimModel

toString

public java.lang.String toString()

Return the string representing model. Override this method if you want to personalize the model's name.

Overrides:

toString in class java.lang.Object

Returns:

The string descripting the model. It is expressed in the form "JAS Model 'ClassName'.