com.net2plan.interfaces.resilienceSimulation

Interface IProvisioningAlgorithm

public interface IProvisioningAlgorithm

Contract that must be fulfilled such that a provisioning algorithm can be run in Net2Plan.

The key difference with algorithms is that provisioning algorithms are used to react to failure/reparation events. In contrast, algorithms are used just for network planning.

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

See Also:

com.net2plan.interfaces.IAlgorithm

Method Summary

Methods

Modifier and Type	Method and Description
ProvisioningActions	executeProvisioningAlgorithm(NetPlan netPlan, ResilienceNetState netState, ResilienceEvents event) Executes the provisioning algorithm.
String	finish(StringBuilder output)
String	getDescription() Returns the description.
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.
void	initialize(NetPlan netPlan, ResilienceNetState netState, Map<String,String> algorithmParameters, Map<String,String> net2planParameters)

Method Detail

getDescription

String getDescription()

Returns the description.

Returns:

Description

Since:

0.2.0

getParameters

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.

Returns:

List of specific parameters

Since:

0.2.0

executeProvisioningAlgorithm

ProvisioningActions executeProvisioningAlgorithm(NetPlan netPlan,
                                               ResilienceNetState netState,
                                               ResilienceEvents event)

Executes the provisioning algorithm.

Parameters:

netPlan - Network plan

netState - Current network state

event - Resilience event: node/link/SRG failure, node/link/SRG reparation

Returns:

List of actions to perform

Since:

0.2.0

initialize

void initialize(NetPlan netPlan,
              ResilienceNetState netState,
              Map<String,String> algorithmParameters,
              Map<String,String> net2planParameters)

finish

String finish(StringBuilder output)