org.javades.jsimulation.r5

Class DefaultSimEvent<T>

java.lang.Object

org.javades.jsimulation.r5.DefaultSimEvent<T>

Type Parameters:

T - The type of the user object.

All Implemented Interfaces:

SimEvent<T>

public class DefaultSimEvent<T>
extends Object
implements SimEvent<T>

An implementation of a SimEvent.

A DefaultSimEvent is not thread-safe.

Last javadoc Review: Jan de Jongh, TNO, 20180404, r5.1.0.

See Also:

SimEvent, DefaultSimEventComparator

Constructor Summary

Constructors

Constructor and Description
DefaultSimEvent() Creates a new DefaultSimEvent named \"No Name\", time at negative infinity and null object and action.
DefaultSimEvent(double time) Creates a new DefaultSimEvent named \"No Name\", given time and null object and action.
DefaultSimEvent(double time, SimEventAction eventAction) Creates a new DefaultSimEvent named \"No Name\", given time and action and null object.
DefaultSimEvent(double time, T object, SimEventAction eventAction) Creates a new DefaultSimEvent with given parameters and name \"No Name\" (main constructor).
DefaultSimEvent(String name, double time, T object, SimEventAction eventAction) Creates a new DefaultSimEvent with given parameters.

Method Summary

Modifier and Type	Method and Description
SimEventAction	getEventAction() Returns the SimEventAction associated with this event.
String	getName() Gets the name of this SimEvent.
T	getObject() Returns the user object associated with this event.
long	getSimEventListDeconflictValue() Returns the value used for "de-conflicting" simultaneous events on a SimEventList.
double	getTime() Returns the time at which this SimEvent is (to be) scheduled on a SimEventList.
void	setEventAction(SimEventAction eventAction) Sets the SimEventAction associated with this event.
void	setName(String name) Sets the name of this SimEvent.
void	setObject(T object) Sets the user object associated with this event.
void	setSimEventListDeconflictValue(long simEventListDeconflictValue) Sets the value used for "de-conflicting" simultaneous events on a SimEventList.
void	setTime(double time) Sets the time at which this SimEvent is to be scheduled on a SimEventList.
String	toString() Returns the registered name if non-null, else the super method return value.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSimEvent

public DefaultSimEvent(String name,
                       double time,
                       T object,
                       SimEventAction eventAction)

Creates a new DefaultSimEvent with given parameters.

Parameters:

name - The name of the event.

time - The time at which the event is to be scheduled on a SimEventList.

object - The associated user object (may be null).

eventAction - The associated event action (may be null).

DefaultSimEvent

public DefaultSimEvent(double time,
                       T object,
                       SimEventAction eventAction)

Creates a new DefaultSimEvent with given parameters and name \"No Name\" (main constructor).

Parameters:

time - The time at which the event is to be scheduled on a SimEventList.

object - The associated user object (may be null).

eventAction - The associated event action (may be null).

DefaultSimEvent

public DefaultSimEvent(double time,
                       SimEventAction eventAction)

Creates a new DefaultSimEvent named \"No Name\", given time and action and null object.

Parameters:

time - The time at which the event is to be scheduled on a SimEventList.

eventAction - The associated event action (may be null).

DefaultSimEvent

public DefaultSimEvent(double time)

Creates a new DefaultSimEvent named \"No Name\", given time and null object and action.

Parameters:

time - The time at which the event is to be scheduled on a SimEventList.

DefaultSimEvent

public DefaultSimEvent()

Creates a new DefaultSimEvent named \"No Name\", time at negative infinity and null object and action.

Method Detail

getName

public final String getName()

Description copied from interface: SimEvent

Gets the name of this SimEvent.

The name may be null. It is not used by the jsimulation package, except for logging purposes.

Specified by:

getName in interface SimEvent<T>

Returns:

The name of the event (may be null).

setName

public final void setName(String name)

Description copied from interface: SimEvent

Sets the name of this SimEvent.

The name may be null. It is not used by the jsimulation package, except for logging purposes.

Specified by:

setName in interface SimEvent<T>

Parameters:

name - The new name of the event (may be null).

toString

public String toString()

Returns the registered name if non-null, else the super method return value.

Overrides:

toString in class Object

Returns:

The registered name if non-null, else the super method return value.

See Also:

getName()

getTime

public final double getTime()

Description copied from interface: SimEvent

Returns the time at which this SimEvent is (to be) scheduled on a SimEventList.

The time property should not be changed when the event is currently scheduled on a SimEventList.

Specified by:

getTime in interface SimEvent<T>

Returns:

The time at which this SimEvent is (to be) scheduled on a SimEventList.

setTime

public final void setTime(double time)

Description copied from interface: SimEvent

Sets the time at which this SimEvent is to be scheduled on a SimEventList.

The time property should not be changed when the event is currently scheduled on a SimEventList.

Specified by:

setTime in interface SimEvent<T>

Parameters:

time - The new time at which this SimEvent is to be scheduled on a SimEventList.

getSimEventListDeconflictValue

public final long getSimEventListDeconflictValue()

Description copied from interface: SimEvent

Returns the value used for "de-conflicting" simultaneous events on a SimEventList.

This method is for internal use by a SimEventList. Implementations must keep a private long (or Long) member to keep the property.

Specified by:

getSimEventListDeconflictValue in interface SimEvent<T>

Returns:

The value used for "de-conflicting" simultaneous events on a SimEventList.

setSimEventListDeconflictValue

public final void setSimEventListDeconflictValue(long simEventListDeconflictValue)

Description copied from interface: SimEvent

Sets the value used for "de-conflicting" simultaneous events on a SimEventList.

This method is for internal use by a SimEventList. Implementations must keep a private long (or Long) member to keep the property.

Specified by:

setSimEventListDeconflictValue in interface SimEvent<T>

Parameters:

simEventListDeconflictValue - The new value used for "de-conflicting" simultaneous events on a SimEventList.

getObject

public final T getObject()

Description copied from interface: SimEvent

Returns the user object associated with this event.

The user object need not be present (may be null and is never used or changed by the nl.jdj.jsimulation} package. Also, multiple SimEvents may share a single user object. Note, however, that the user object (property) should not be changed when the SimEvent is scheduled on a SimEventList.

Specified by:

getObject in interface SimEvent<T>

Returns:

The user object associated with this event.

setObject

public final void setObject(T object)

Description copied from interface: SimEvent

Sets the user object associated with this event.

The user object need not be present (may be null and is never used or changed by the jsimulation package. Also, multiple SimEvents may share a single user object. Note, however, that the user object (property) should not be changed when the SimEvent is scheduled on a SimEventList.

Specified by:

setObject in interface SimEvent<T>

Parameters:

object - The new user object (not checked).

getEventAction

public final SimEventAction getEventAction()

Description copied from interface: SimEvent

Returns the SimEventAction associated with this event.

The action is invoked when the event is executed on the SimEventList. The event action (property) should not be changed when the SimEvent is scheduled on a SimEventList.

Specified by:

getEventAction in interface SimEvent<T>

Returns:

The SimEventAction (may be null) associated with this event.

setEventAction

public final void setEventAction(SimEventAction eventAction)

Description copied from interface: SimEvent

Sets the SimEventAction associated with this event.

The action is invoked when the event is executed on the SimEventList. The event action (property) should not be changed when the SimEvent is scheduled on a SimEventList.

Specified by:

setEventAction in interface SimEvent<T>

Parameters:

eventAction - The new SimEventAction (may be null) associated with this event.