com.net2plan.interfaces.simulation

Class SimEvent

Object

com.net2plan.interfaces.simulation.SimEvent

All Implemented Interfaces:

Comparable<SimEvent>

public class SimEvent
extends Object
implements Comparable<SimEvent>

Class representing a simulation event.

Regardless specific event details, every event is defined by the event arrival time and a priority value. The highest priority event is called first.

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

See Also:

Wikipedia, "Discrete event simulation," Wikipedia, The Free Encyclopedia

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimEvent.DestinationModule Module that will receive the associated event.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRIORITY Default priority for events (higher values give higher priority).
static int	DEFAULT_TYPE Default type for events.

Constructor Summary

Constructors

Constructor and Description
SimEvent(double eventTime, List<SimAction> actions, Object object, SimEvent.DestinationModule destinationModule) Constructor that allows to generate an event with a custom object and a list of action notifications.
SimEvent(double eventTime, List<SimAction> actions, SimEvent.DestinationModule destinationModule) Constructor that allows to generate an event with a list of action notifications.
SimEvent(double eventTime, Object object, SimEvent.DestinationModule destinationModule) Constructor that allows to generate an event with a custom object.
SimEvent(double eventTime, SimAction action, SimEvent.DestinationModule destinationModule) Constructor that allows to generate an event with an action notification.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(SimEvent e)
boolean	contains(SimAction.ActionType actionType) Returns true if the event contains an action notification of the given type.
boolean	containsAny(EnumSet<SimAction.ActionType> actionTypes) Returns true if the event contains an action notification of among one of the given types.
List<SimAction>	getEventActionList() Returns the list of action notifications.
SimEvent.DestinationModule	getEventDestinationModule() Returns the destination module of the event.
Object	getEventObject() Returns the custom object of the event (may be null).
int	getEventPriority() Returns the event priority.
double	getEventTime() Returns the event time.
int	getEventType() Returns the custom event type.
SimEvent	setEventPriority(int priority) Sets scheduling priority of the message.
SimEvent	setEventType(int type) Sets the message kind.
String	toString()

Methods inherited from class Object

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

Field Detail

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

Default priority for events (higher values give higher priority).

Since:

0.2.0

See Also:

Constant Field Values

DEFAULT_TYPE

public static final int DEFAULT_TYPE

Default type for events.

Since:

0.3.0

See Also:

Constant Field Values

Constructor Detail

SimEvent

public SimEvent(double eventTime,
        List<SimAction> actions,
        Object object,
        SimEvent.DestinationModule destinationModule)

Constructor that allows to generate an event with a custom object and a list of action notifications.

Parameters:

eventTime - Event time

actions - List of actions to be notified

object - Custom object

destinationModule - Module that will receive the event

Since:

0.3.0

SimEvent

public SimEvent(double eventTime,
        List<SimAction> actions,
        SimEvent.DestinationModule destinationModule)

Constructor that allows to generate an event with a list of action notifications.

Parameters:

eventTime - Event time

actions - List of actions to be notified

destinationModule - Module that will receive the event

Since:

0.3.0

SimEvent

public SimEvent(double eventTime,
        Object object,
        SimEvent.DestinationModule destinationModule)

Constructor that allows to generate an event with a custom object.

Parameters:

eventTime - Event time

object - Custom object

destinationModule - Module that will receive the event

Since:

0.3.0

SimEvent

public SimEvent(double eventTime,
        SimAction action,
        SimEvent.DestinationModule destinationModule)

Constructor that allows to generate an event with an action notification.

Parameters:

eventTime - Event time

action - Action to be notified

destinationModule - Module that will receive the event

Since:

0.3.0

Method Detail

compareTo

public final int compareTo(SimEvent e)

Specified by:

compareTo in interface Comparable<SimEvent>

contains

public boolean contains(SimAction.ActionType actionType)

Returns true if the event contains an action notification of the given type.

Parameters:

actionType - Type of action notification

Returns:

true if the event contains an action notification of the given type. Otherwise, false

Since:

0.3.0

containsAny

public boolean containsAny(EnumSet<SimAction.ActionType> actionTypes)

Returns true if the event contains an action notification of among one of the given types.

Parameters:

actionTypes - Types of action notification

Returns:

true if the event contains an action notification of any of the given type. Otherwise, false

Since:

0.3.0

getEventActionList

public final List<SimAction> getEventActionList()

Returns the list of action notifications.

Important: The returned list is unmodifiable

Returns:

List of action notifications

Since:

0.3.0

getEventDestinationModule

public final SimEvent.DestinationModule getEventDestinationModule()

Returns the destination module of the event.

Returns:

List of action notifications

Since:

0.3.0

getEventObject

public final Object getEventObject()

Returns the custom object of the event (may be null).

Returns:

Custom object

Since:

0.3.0

getEventPriority

public final int getEventPriority()

Returns the event priority.

Returns:

Event priority

Since:

0.2.0

getEventTime

public final double getEventTime()

Returns the event time.

Returns:

Event time

Since:

0.2.0

getEventType

public final int getEventType()

Returns the custom event type.

Returns:

Event type

Since:

0.3.0

setEventPriority

public final SimEvent setEventPriority(int priority)

Sets scheduling priority of the message. The priority value is used when the simulator inserts messages into the future event list (FEL), to order messages with identical arrival time values.

Parameters:

priority - Event priority (the higher, the more priority)

Returns:

Reference to the event

Since:

0.3.0

setEventType

public final SimEvent setEventType(int type)

Sets the message kind. This field can be freely used by the user. No processing is made by the simulation kernel.

Parameters:

type - Event type

Returns:

Reference to the event

Since:

0.3.0

toString

public String toString()

Overrides:

toString in class Object