com.net2plan.interfaces.simulation

Class IEventGenerator

Object

ISimExternal

com.net2plan.interfaces.simulation.IEventGenerator

Direct Known Subclasses:

ICombinedEventGenerator

public abstract class IEventGenerator
extends ISimExternal

Abstract class that must be inherited so that an event generator can be executed inside the Online network simulation tool included within Net2Plan.

Since:

0.3.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Constructor Summary

Constructors

Constructor and Description
IEventGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
void	endSimulation() Throws an 'end of simulation' exception, so that the kernel finishes immediately the simulation, and it triggers the finish() method.
void	endTransitory() Indicates to the kernel that the transitory should be finished after processing the current event, triggering the finishTransitory() method of both event generator and processor.
String	finish(StringBuilder output, double simTime) Returns an algorithm-specific report.
void	finishTransitory(double simTime) Performs some transitory-finished action.
abstract String	getDescription() Returns the description.
abstract List<Triple<String,String,String>>	getParameters() Returns the list of required parameters, where the first item of each element is the parameter name, the second one is the parameter value, and the third one is the parameter description.
abstract void	initialize(NetPlan initialNetPlan, NetPlan currentNetPlan, Map<String,String> algorithmParameters, Map<String,String> simulationParameters, Map<String,String> net2planParameters) Initializes the algorithm (i.e. reading input parameters).
abstract void	processEvent(NetPlan currentNetPlan, SimEvent event) Processes the next event in the future event list.
void	scheduleEvent(SimEvent event) Adds a new event to the future event list.

Methods inherited from class Object

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

Constructor Detail

IEventGenerator

public IEventGenerator()

Method Detail

endSimulation

public final void endSimulation()

Throws an 'end of simulation' exception, so that the kernel finishes immediately the simulation, and it triggers the finish() method.

Important: Please, do not catch this exception inside your code.

Since:

0.3.0

endTransitory

public final void endTransitory()

Indicates to the kernel that the transitory should be finished after processing the current event, triggering the finishTransitory() method of both event generator and processor.

If the transitory finished previously, this will have no effect.

Since:

0.3.0

finish

public String finish(StringBuilder output,
            double simTime)

Returns an algorithm-specific report.

Parameters:

output - Container for the report

simTime - Current simulation time

Returns:

Report title (return null, or an empty output to omit it)

Since:

0.3.0

finishTransitory

public void finishTransitory(double simTime)

Performs some transitory-finished action.

Parameters:

simTime - Current time

Since:

0.3.0

getDescription

public abstract String getDescription()

Returns the description.

Returns:

Description

Since:

0.3.0

getParameters

public abstract List<Triple<String,String,String>> getParameters()

Returns the list of required parameters, where the first item of each element is the parameter name, the second one is the parameter value, and the third one is the parameter description.

It is possible to define type-specific parameters if the default value is set according to the following rules (but user is responsible of checking in its own code):

• If the default value is #select# and a set of space- or comma-separated values, the GUI will show a combobox with all the values, where the first one will be the selected one by default. For example: "#select# hops km" will allow choosing in the GUI between hops and km, where hops will be the default value.
• If the default value is #boolean# and true or false, the GUI will show a checkbox, where the default value will be true or false, depending on the value accompanying to #boolean#. For example: "#boolean# true" will show a checkbox marked by default.
• If the default value is #algorithm#, the GUI will prepare a new interface to select an algorithm as parameter. Three new fields will be added, including "_file", "_classname" and "_parameters" suffixes to the indicated parameter name, refer to the .class or .jar file where the code is located, the class name, and a set of parameters (pair of key-values separated by commas, where individual key and value are separated with an equal symbol. The same applies to reports (#report#), event generators (#eventGenerator#) and event processors (#eventProcessor#).

Returns:

List of specific parameters

Since:

0.3.0

initialize

public abstract void initialize(NetPlan initialNetPlan,
              NetPlan currentNetPlan,
              Map<String,String> algorithmParameters,
              Map<String,String> simulationParameters,
              Map<String,String> net2planParameters)

Initializes the algorithm (i.e. reading input parameters).

Parameters:

initialNetPlan - Initial network plan

currentNetPlan - Current network plan

algorithmParameters - A key-value map with specific algorithm parameters.

Important: The algorithm developer is responsible to convert values from String to their respective type, and to check that values

simulationParameters - A key-value map with simulation parameters

net2planParameters - A key-value map with Net2Plan-wide configuration options

Since:

0.3.0

processEvent

public abstract void processEvent(NetPlan currentNetPlan,
                SimEvent event)

Processes the next event in the future event list. It is called only for the destination module of the event. In addition, new events can be scheduled using the scheduleEvent method.

Parameters:

currentNetPlan - Current network plan

event - Current event to be processed

Since:

0.3.0

scheduleEvent

public final void scheduleEvent(SimEvent event)

Adds a new event to the future event list.

Parameters:

event - Event to be scheduled

Since:

0.3.0