gsim.sim.engine.common
Class ScenarioEvent

java.lang.Object
  gsim.sim.engine.common.ScenarioEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public abstract class ScenarioEvent
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Instances of the ScenarioEvent class get loaded by the Scheduler object during runtime, where its execute-method is called. Sub-classes have to implement the execute method. A ScenarioEvent is identified by two parameter target and action. The idea was that the target object could be any object on which something should be executed, but in practice it's more or less only an additional identificator like the string action - because usually a reference to the model, and with this to any object in the simulation can be set (was more practical). The field optionalParameter can be used to handle possible arguments (the reason for this was to have a common interface for a UI, but I don't know if this makes really sense).

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Constructor Summary

ScenarioEvent(java.lang.String groupName, java.lang.String eventName)

Method Summary

abstract java.lang.Object	clone()
abstract void	execute()
java.lang.String	getDescriptionFile()
java.lang.String	getEventName()
long	getExecutionTime()
java.lang.String	getGroupName()
java.lang.Object[]	getOptionalParameterFillers()
java.lang.String	getOptionalParameterName()
java.lang.Object	getOptionalParameterValue()
boolean	isInterval()
void	setCoordinatorRef(ModelState state)
void	setDescriptionFile(java.lang.String fileName)
void	setExecutionTime(long t)
void	setInterval(boolean b)
void	setOptionalFillers(java.lang.Object[] o)
void	setOptionalParameterValue(java.lang.Object o)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ScenarioEvent

public ScenarioEvent(java.lang.String groupName,
                     java.lang.String eventName)

Method Detail

clone

public abstract java.lang.Object clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setCoordinatorRef

public void setCoordinatorRef(ModelState state)

setInterval

public void setInterval(boolean b)

isInterval

public boolean isInterval()

setExecutionTime

public void setExecutionTime(long t)

getExecutionTime

public long getExecutionTime()

execute

public abstract void execute()

setOptionalFillers

public void setOptionalFillers(java.lang.Object[] o)

setOptionalParameterValue

public void setOptionalParameterValue(java.lang.Object o)

getOptionalParameterFillers

public java.lang.Object[] getOptionalParameterFillers()

getOptionalParameterValue

public java.lang.Object getOptionalParameterValue()

getGroupName

public java.lang.String getGroupName()

getEventName

public java.lang.String getEventName()

getOptionalParameterName

public java.lang.String getOptionalParameterName()

getDescriptionFile

public java.lang.String getDescriptionFile()

setDescriptionFile

public void setDescriptionFile(java.lang.String fileName)