Package microsim.event

Class SystemEvent

java.lang.Object

microsim.event.Event

microsim.event.SystemEvent

All Implemented Interfaces:

Comparable<Event>

public class SystemEvent
extends Event

System events are directly processed by the simulation engine. There are some special events that engine is able to understand. For instance, you can schedule the end of simulation using a system event SystemEventType.END by passing it to EventQueue.

Field Summary

Fields inherited from class microsim.event.Event

loop, ordering, time

Constructor Summary

Constructors

Constructor	Description
SystemEvent(@NonNull SimulationEngine engine, @NonNull SystemEventType type)	The default constructor.

Method Summary

Modifier and Type	Method	Description
void	fireEvent()	Triggers the event based on its type
@NonNull String	toString()	Converts this system event to a string.

Methods inherited from class microsim.event.Event

compareTo, setTimeAtNextLoop, setTimeOrderingAndLoopPeriod

Methods inherited from class java.lang.Object

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

Constructor Details

SystemEvent

public SystemEvent(@NonNull
 @NonNull SimulationEngine engine,
 @NonNull
 @NonNull SystemEventType type)

The default constructor.

Parameters:

engine - A SimulationEngine object.

type - The type of system event.

Throws:

NullPointerException - when any of the input object is null.

Method Details

fireEvent

public void fireEvent()
               throws SimulationException

Triggers the event based on its type

Specified by:

fireEvent in class Event

Throws:

SimulationException - when the engine fails to progress current simulation.

toString

@NonNull
public @NonNull String toString()

Converts this system event to a string.

Overrides:

toString in class Object

Returns:

the string representation of an event.