IRPact_modellierung.events

Class Event

java.lang.Object

IRPact_modellierung.SimulationEntity

IRPact_modellierung.events.Event

All Implemented Interfaces:

java.lang.Comparable<Event>

Direct Known Subclasses:

CommunicationEvent, InformationEvent, NeedEvent, PostPurchaseEvaluationEvent, ScriptedEvent

public abstract class Event
extends SimulationEntity
implements java.lang.Comparable<Event>

An event is an abstraction representing any model dynamics. It is created by an entity involved in the (concrete) model dynamic, and serves to interact with (not necessarily other) entities in that model dynamic. It is closely tied to the temporal model by its scheduled time, and managed by an EventScheduler. Its effects are modeled within the event through their processing method. Every (distinct) model dynamic should model their own type of event, formalizing their dynamics in its processing method.

Field Summary

Fields inherited from class IRPact_modellierung.SimulationEntity

associatedSimulationContainer

Constructor Summary

Constructors

Constructor and Description
Event(SimulationContainer simulationContainer, double scheduledForTime) Abstraction of an event representing a model dynamic at a specified time

Method Summary

Modifier and Type	Method and Description
int	compareTo(Event otherEvent) Method to compare the execution time of this event to another event for sorting events by execution time
double	getScheduledForTime()
abstract void	processEvent(double systemTime) Method to execute the event; Will make the model dynamics associated to this event come into effect

Methods inherited from class IRPact_modellierung.SimulationEntity

getAssociatedSimulationContainer

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(SimulationContainer simulationContainer,
             double scheduledForTime)
      throws java.lang.IllegalArgumentException

Abstraction of an event representing a model dynamic at a specified time

Parameters:

simulationContainer - The simulation container the model dynamic is to take place in

scheduledForTime - The simulation time at which the event shall be processed

Throws:

java.lang.IllegalArgumentException - When the simulation container is null or the scheduled time lies before the (reference) time within the simulation container

Method Detail

getScheduledForTime

public double getScheduledForTime()

compareTo

public int compareTo(Event otherEvent)

Method to compare the execution time of this event to another event for sorting events by execution time

Specified by:

compareTo in interface java.lang.Comparable<Event>

Parameters:

otherEvent - Event that to reference the scheduled time of this event to

Returns:

-1 if this event is scheduled before otherEvent, 0 if both events are scheduled for the same time, 1 if event is scheduled to be executed after otherEvent

processEvent

public abstract void processEvent(double systemTime)

Method to execute the event; Will make the model dynamics associated to this event come into effect

Parameters:

systemTime - The current time of the system for execution