jas.events
Class EventList

java.lang.Object
  java.lang.Thread
      jas.events.EventList

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

RealTimeEventList

public class EventList
extends java.lang.Thread

The event list manages a time ordered list of events. It is based on a linked list. At every simulation step the head of the list is taken and fired. This class extends a thread, because it runs independently from other processes. When activated it runs the simulation.

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

Nested Class Summary

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

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

Field Summary

static int

EVENT_LIST_STEP The action type passed to step listeners.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

EventList()
Build new event list with TIME_TICKS time unit.

EventList(EventList previousEventList)
Build new event list inheriting paramteters from another EventList.

EventList(int timeUnit)
Build new event list with the given time unit.

Method Summary

void	addEventListener(ISimEventListener listener) Add an event listener to the listeners list.
void	addMultiCastService(java.lang.String multiCastService, SimMultiCastEvent event) Create new multicast information service.
void	clear() Empty the event list ans set up time for a new simulation.
void	clearEventListeners() Empty the stepListeners list .
java.lang.Object[]	getEventArray() Return event list as array of Object.
int	getEventTimeTreshold() Return the current delay time beetween two simulation steps.
SimMultiCastEvent	getMultiCastService(java.lang.String multiCastService) Return the multicast information service with the given name.
boolean	getRunningStatus() Return current simulation running status.
static long	getSimulationTimeout() Return current simulation timeout.
SimTime	getTime() Return current simulation timer.
void	removeEventListener(ISimEventListener listener) Remove a listener from the listeners list.
void	run() Start the independent thread running simulation.
void	schedule(SimEvent event) Schedule a generic event.
void	schedule(SimEvent event, long atTime) Schedule a generic event at a given time.
void	schedule(SimEvent event, long atTime, int withLoop) Schedule a generic looped event at a given time.
SimCollectionEvent	scheduleCollection(long atTime, java.util.Collection elements, java.lang.Class objectType, java.lang.String method) Schedule a collection event using late binding method call.
SimCollectionEvent	scheduleCollection(long atTime, java.util.Collection elements, int actionType) Schedule a collection event using early binding method call.
SimCollectionEvent	scheduleCollection(long atTime, int withLoop, java.util.Collection elements, java.lang.Class objectType, java.lang.String method) Schedule a looped collection event using late binding method call.
SimCollectionEvent	scheduleCollection(long atTime, int withLoop, java.util.Collection elements, int actionType) Schedule a looped collection event using early binding method call.
SimGroupEvent	scheduleGroup(long atTime) Schedule a group of events.
SimGroupEvent	scheduleGroup(long atTime, int withLoop) Schedule a looped group of events.
SimMultiCastEvent	scheduleMultiCast(long atTime, int withLoop, java.lang.String multiCastService, java.util.Collection elements, int actionType) Schedule a looped multicast event using early binding method call.
SimMultiCastEvent	scheduleMultiCast(long atTime, java.lang.String multiCastService, java.util.Collection elements, int actionType) Schedule a multicast event using early binding method call.
SimSimpleEvent	scheduleSimple(long atTime, int withLoop, java.lang.Object object, int actionType) Schedule a looped simple event using early binding method call.
SimSimpleEvent	scheduleSimple(long atTime, int withLoop, java.lang.Object object, java.lang.String method) Schedule a looped simple event using late binding method call.
SimSimpleEvent	scheduleSimple(long atTime, java.lang.Object object, int actionType) Schedule a simple event using early binding method call.
SimSimpleEvent	scheduleSimple(long atTime, java.lang.Object object, java.lang.String method) Schedule a simple event using late binding method call.
SimSystemEvent	scheduleSystem(long atTime, int actionType) Schedule a system event.
SimSystemEvent	scheduleSystem(long atTime, int withLoop, int actionType) Schedule a looped system event.
void	setEventTimeTreshold(int millis) Set the delay time beetween two simulation steps.
void	setRunningStatus(boolean running) Set current simulation running status.
static void	setSimulationTimeout(long steps) Set the simulation timeout.
void	simulate() Run an entire simulation.
void	step() Make one simulation step.
void	unschedule(SimEvent event) Remove from event list the given event.

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

Field Detail

EVENT_LIST_STEP

public static final int EVENT_LIST_STEP

The action type passed to step listeners. The int value is 10000.

See Also:

Constant Field Values

Constructor Detail

EventList

public EventList()

Build new event list with TIME_TICKS time unit.

EventList

public EventList(EventList previousEventList)

Build new event list inheriting paramteters from another EventList.

EventList

public EventList(int timeUnit)

Build new event list with the given time unit.

Method Detail

addEventListener

public void addEventListener(ISimEventListener listener)

Add an event listener to the listeners list. When an object implementing ISimEventListener iterface enters this register at each simulation step it will be informed.

addMultiCastService

public void addMultiCastService(java.lang.String multiCastService,
                                SimMultiCastEvent event)

Create new multicast information service.

Parameters:

multiCastService - Information service name.

event - Event to be fired when multicast event is fired.

clear

public void clear()

Empty the event list ans set up time for a new simulation.

clearEventListeners

public void clearEventListeners()

Empty the stepListeners list .

getEventArray

public java.lang.Object[] getEventArray()

Return event list as array of Object.

getEventTimeTreshold

public int getEventTimeTreshold()

Return the current delay time beetween two simulation steps.

getMultiCastService

public SimMultiCastEvent getMultiCastService(java.lang.String multiCastService)

Return the multicast information service with the given name.

getRunningStatus

public boolean getRunningStatus()

Return current simulation running status.

getSimulationTimeout

public static long getSimulationTimeout()

Return current simulation timeout. If not previously set it returns the default value.

getTime

public SimTime getTime()

Return current simulation timer.

removeEventListener

public void removeEventListener(ISimEventListener listener)

Remove a listener from the listeners list.

run

public void run()

Start the independent thread running simulation. It fire events only if running status is set to true.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

schedule

public void schedule(SimEvent event)

Schedule a generic event.

schedule

public void schedule(SimEvent event,
                     long atTime)

Schedule a generic event at a given time.

Parameters:

atTime - The time when event will be fired.

schedule

public void schedule(SimEvent event,
                     long atTime,
                     int withLoop)

Schedule a generic looped event at a given time.

Parameters:

atTime - The time when event will be fired for the first time.

withLoop - The time between the first shot and the next ones.

scheduleCollection

public SimCollectionEvent scheduleCollection(long atTime,
                                             java.util.Collection elements,
                                             java.lang.Class objectType,
                                             java.lang.String method)

Schedule a collection event using late binding method call.
Warning: The generic method description is slower then early binding method call.

scheduleCollection

public SimCollectionEvent scheduleCollection(long atTime,
                                             java.util.Collection elements,
                                             int actionType)

Schedule a collection event using early binding method call.

scheduleCollection

public SimCollectionEvent scheduleCollection(long atTime,
                                             int withLoop,
                                             java.util.Collection elements,
                                             java.lang.Class objectType,
                                             java.lang.String method)

Schedule a looped collection event using late binding method call.
Warning: The generic method description is slower then early binding method call.

scheduleCollection

public SimCollectionEvent scheduleCollection(long atTime,
                                             int withLoop,
                                             java.util.Collection elements,
                                             int actionType)

Schedule a looped collection event using early binding method call.

scheduleGroup

public SimGroupEvent scheduleGroup(long atTime)

Schedule a group of events.

scheduleGroup

public SimGroupEvent scheduleGroup(long atTime,
                                   int withLoop)

Schedule a looped group of events.

scheduleMultiCast

public SimMultiCastEvent scheduleMultiCast(long atTime,
                                           int withLoop,
                                           java.lang.String multiCastService,
                                           java.util.Collection elements,
                                           int actionType)

Schedule a looped multicast event using early binding method call.

scheduleMultiCast

public SimMultiCastEvent scheduleMultiCast(long atTime,
                                           java.lang.String multiCastService,
                                           java.util.Collection elements,
                                           int actionType)

Schedule a multicast event using early binding method call.

scheduleSimple

public SimSimpleEvent scheduleSimple(long atTime,
                                     int withLoop,
                                     java.lang.Object object,
                                     int actionType)

Schedule a looped simple event using early binding method call.

scheduleSimple

public SimSimpleEvent scheduleSimple(long atTime,
                                     int withLoop,
                                     java.lang.Object object,
                                     java.lang.String method)

Schedule a looped simple event using late binding method call.
Warning: The generic method description is slower then early binding method call.

scheduleSimple

public SimSimpleEvent scheduleSimple(long atTime,
                                     java.lang.Object object,
                                     int actionType)

Schedule a simple event using early binding method call.

scheduleSimple

public SimSimpleEvent scheduleSimple(long atTime,
                                     java.lang.Object object,
                                     java.lang.String method)

Schedule a simple event using late binding method call.
Warning: The generic method description is slower then early binding method call.

scheduleSystem

public SimSystemEvent scheduleSystem(long atTime,
                                     int actionType)

Schedule a system event.

scheduleSystem

public SimSystemEvent scheduleSystem(long atTime,
                                     int withLoop,
                                     int actionType)

Schedule a looped system event.

setEventTimeTreshold

public void setEventTimeTreshold(int millis)

Set the delay time beetween two simulation steps.

setRunningStatus

public void setRunningStatus(boolean running)

Set current simulation running status.

setSimulationTimeout

public static void setSimulationTimeout(long steps)

Set the simulation timeout. When simulation is started without activating Control Panel, user cannot stop it. By setting this timeout simulation is automatically stopped after given steps.

simulate

public void simulate()

Run an entire simulation. If model does not stop itself simulation, it will be stop automatically at timeout time.

step

public void step()

Make one simulation step.

unschedule

public void unschedule(SimEvent event)

Remove from event list the given event.