com.net2plan.interfaces.simulation

Class SimEvent

java.lang.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.

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.DemandAdd This class represents the request to add a new Demand.
static class	SimEvent.DemandModify This class represents the request to modify an existing Demand.
static class	SimEvent.DemandRemove This class represents the request to remove an existing Demand.
static class	SimEvent.DestinationModule Module that will receive the associated event.
static class	SimEvent.LinkAdd This class represents the request to add a new Link.
static class	SimEvent.LinkModify This class represents the request to modify an existing Link
static class	SimEvent.LinkRemove This class represents the request to remove an existing Link.
static class	SimEvent.MulticastDemandModify This class represents the request to modify an existing Demand.
static class	SimEvent.NodesAndLinksChangeFailureState This class represents the request to modify the failure state of multiple links and nodes.
static class	SimEvent.RouteAdd This class represents the request to add a new Route.
static class	SimEvent.RouteModify This class represents the request to modify an existing Route.
static class	SimEvent.RouteRemove This class represents the request to remove and existing Route.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SimEvent(double eventTime, SimEvent.DestinationModule destinationModule, int type, int priority, Object object) Constructor that allows to generate an event with a custom object.
SimEvent(double eventTime, SimEvent.DestinationModule destinationModule, int type, Object object) Constructor that allows to generate an event with a custom object.

Method Summary

Modifier and Type	Method and Description
int	compareTo(SimEvent e)
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.
String	toString()

Methods inherited from class java.lang.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).

See Also:

Constant Field Values

Constructor Detail

SimEvent

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

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

Parameters:

eventTime - Event time

destinationModule - Module that will receive the event

type - Event type

priority - Event priority

object - Custom object

SimEvent

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

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

Parameters:

eventTime - Event time

type - Event type

object - Custom object

destinationModule - Module that will receive the event

Method Detail

compareTo

public final int compareTo(SimEvent e)

Specified by:

compareTo in interface Comparable<SimEvent>

getEventDestinationModule

public final SimEvent.DestinationModule getEventDestinationModule()

Returns the destination module of the event.

Returns:

List of action notifications

getEventObject

public final Object getEventObject()

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

Returns:

Custom object

getEventPriority

public final int getEventPriority()

Returns the event priority.

Returns:

Event priority

getEventTime

public final double getEventTime()

Returns the event time.

Returns:

Event time

getEventType

public final int getEventType()

Returns the custom event type.

Returns:

Event type

toString

public String toString()

Overrides:

toString in class Object