Experiment (CloudSim Plus API 4.3.7 API)

java.lang.Object
- org.cloudsimplus.testbeds.Experiment

All Implemented Interfaces:

Runnable
```
public abstract class Experiment
extends Object
implements Runnable
```
A base class to implement simulation experiments that can be executed in a repeatable way by a ExperimentRunner.

Since:

CloudSim Plus 1.0

Author:

Manoel Campos da Silva Filho

Field Summary

Fields
Modifier and Type Field and Description

protected int hostsNumber

Fields
Modifier and Type	Field and Description
`protected int`	`hostsNumber`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Experiment(int index, ExperimentRunner runner)` Instantiates a simulation experiment with 1 Datacenter by default.
`protected`	`Experiment(int index, ExperimentRunner runner, long seed)` Instantiates a simulation experiment that will create 1 broker and 1 Datacenter by default.
	`Experiment(long seed)` Creates a simulation experiment that is not linked to a runner, to enable it to execute just one run.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`build()` Creates the simulation scenario to run the experiment.
`protected void`	`createAndSubmitCloudletsInternal(DatacenterBroker broker)` Creates all the Cloudlets required by the experiment and submits them to a Broker.
`protected abstract DatacenterBroker`	`createBroker()` Creates a DatacenterBroker.
`protected void`	`createBrokers()` Creates a list of brokers.
`protected abstract Cloudlet`	`createCloudlet(DatacenterBroker broker)`
`protected abstract List<Cloudlet>`	`createCloudlets(DatacenterBroker broker)` Creates a list of Cloudlets to be used by the experiment.
`protected DatacenterSimple`	`createDatacenter()` Creates a datacenter using a `VmAllocationPolicy` suplied by the `vmAllocationPolicySupplier`.
`protected abstract Host`	`createHost(int id)`
`protected List<Host>`	`createHosts()`
`protected abstract Vm`	`createVm(DatacenterBroker broker, int id)`
`protected List<Vm>`	`createVms(DatacenterBroker broker)` Creates the Vms to be used by the experiment.
`List<DatacenterBroker>`	`getBrokerList()` Gets the list of created DatacenterBrokers.
`int`	`getBrokersNumber()` Gets the number of brokers to create.
`List<Cloudlet>`	`getCloudletList()`
`List<DatacenterSimple>`	`getDatacenterList()`
`int`	`getDatacentersNumber()`
`int`	`getIndex()` The index that identifies the current experiment run.
`ExperimentRunner`	`getRunner()` Gets the object that is in charge to run the experiment.
`long`	`getSeed()`
`CloudSim`	`getSimulation()`
`List<Vm>`	`getVmList()`
`protected Function<DatacenterBroker,Integer>`	`getVmsByBrokerFunction()` Gets a `Function` that receives a `DatacenterBroker` and returns the number of Vms to create for that broker.
`boolean`	`isNotVerbose()` Indicates if simulation results of the experiment don't have to be output.
`boolean`	`isVerbose()` Indicates if simulation results of the experiment have to be output.
`protected int`	`nextCloudletId()`
`protected int`	`nextVmId()`
`void`	`print(String msg)` Prints a message only if `isVerbose()`.
`void`	`print(String format, Object... args)` Prints a formatted message only if `isVerbose()`.
`void`	`println()` Prints a line break only if `isVerbose()`.
`void`	`println(String msg)` Prints a message and a line break only if `isVerbose()`.
`void`	`println(String format, Object... args)` Prints a formatted message and a line break only if `isVerbose()`.
`abstract void`	`printResults()` Prints the results for the experiment.
`void`	`run()` Builds the simulation scenario and starts execution.
`<T extends Experiment> Experiment`	`setAfterExperimentBuild(Consumer<T> afterExperimentBuild)` Sets a `Consumer` that will be called after the simulation scenario is built, which is before starting the simulation.
`<T extends Experiment> Experiment`	`setAfterExperimentFinish(Consumer<T> afterExperimentFinishConsumer)` Sets a `Consumer` object that will receive the experiment instance after the experiment finishes executing and performs some post-processing tasks.
`Experiment`	`setBrokersNumber(int brokersNumber)` Sets the number of brokers to create.
`void`	`setDatacentersNumber(int datacentersNumber)`
`protected void`	`setHostsNumber(int hostsNumber)`
`Experiment`	`setVerbose(boolean verbose)` Defines if simulation results of the experiment have to be output or not.
`void`	`setVmAllocationPolicySupplier(Supplier<VmAllocationPolicy> vmAllocationPolicySupplier)`
`void`	`setVmsByBrokerFunction(Function<DatacenterBroker,Integer> vmsByBrokerFunction)` Sets a `Function` that receives a `DatacenterBroker` and returns the number of Vms to create for that broker.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - hostsNumber
```
protected int hostsNumber
```
- Constructor Detail
  - Experiment
```
public Experiment(long seed)
```
    Creates a simulation experiment that is not linked to a runner, to enable it to execute just one run.
  - Experiment
```
public Experiment(int index,
                  ExperimentRunner runner)
```
    Instantiates a simulation experiment with 1 Datacenter by default.
    
    Parameters:
    
    index - the index that identifies the current experiment run.
    
    runner - The ExperimentRunner that is in charge of executing this experiment a defined number of times and to collect data for statistical analysis.
    
    See Also:
    
    setDatacentersNumber(int)
  - Experiment
```
protected Experiment(int index,
                     ExperimentRunner runner,
                     long seed)
```
    Instantiates a simulation experiment that will create 1 broker and 1 Datacenter by default.
    
    Parameters:
    
    index - the index that identifies the current experiment run.
    
    runner - The ExperimentRunner to execute the experiment. If omitted, it means the experiment is independent and may be run just once. If you don't provide a runner, you must provide a seed
    
    seed - the seed to be set. If a runner is given, this value is ignored and the seed is generated from the runner base seed. If you don't provide a seed, you must provide a runner.
    
    See Also:
    
    setBrokersNumber(int), setDatacentersNumber(int)
- Method Detail
  - getCloudletList
```
public final List<Cloudlet> getCloudletList()
```
  - getVmList
```
public List<Vm> getVmList()
```
  - setVerbose
```
public Experiment setVerbose(boolean verbose)
```
    Defines if simulation results of the experiment have to be output or not.
    
    Parameters:
    
    verbose - true if the results have to be output, false otherwise
    
    Returns:
  - getIndex
```
public int getIndex()
```
    The index that identifies the current experiment run.
    
    Returns:
  - isNotVerbose
```
public boolean isNotVerbose()
```
    Indicates if simulation results of the experiment don't have to be output.
    
    Returns:
  - isVerbose
```
public boolean isVerbose()
```
    Indicates if simulation results of the experiment have to be output.
    
    Returns:
  - run
```
public final void run()
```
    Builds the simulation scenario and starts execution.
    
    Specified by:
    
    run in interface Runnable
    
    Throws:
    
    RuntimeException
  - printResults
```
public abstract void printResults()
```
    Prints the results for the experiment. The method has to be implemented by subclasses in order to output the experiment results.
    
    See Also:
    
    printResultsInternal()
  - build
```
protected final void build()
```
    Creates the simulation scenario to run the experiment.
  - createDatacenter
```
protected DatacenterSimple createDatacenter()
```
    Creates a datacenter using a VmAllocationPolicy suplied by the vmAllocationPolicySupplier.
    
    Returns:
    
    See Also:
    
    setVmAllocationPolicySupplier(Supplier)
  - createBrokers
```
protected void createBrokers()
```
    Creates a list of brokers. This is the entry-point for broker creation.
  - createBroker
```
protected abstract DatacenterBroker createBroker()
```
    Creates a DatacenterBroker.
    
    Returns:
    
    the created DatacenterBroker
  - createCloudlets
```
protected abstract List<Cloudlet> createCloudlets(DatacenterBroker broker)
```
    Creates a list of Cloudlets to be used by the experiment.
    
    Parameters:
    
    broker - the broker to create the Cloudlets to
    
    Returns:
    
    the list of created cloudlets
  - createCloudlet
```
protected abstract Cloudlet createCloudlet(DatacenterBroker broker)
```
  - createVms
```
protected List<Vm> createVms(DatacenterBroker broker)
```
    Creates the Vms to be used by the experiment.
    
    Parameters:
    
    broker -
    
    Returns:
    
    the List of created VMs
  - createVm
```
protected abstract Vm createVm(DatacenterBroker broker,
                               int id)
```
  - nextVmId
```
protected final int nextVmId()
```
  - nextCloudletId
```
protected final int nextCloudletId()
```
  - createAndSubmitCloudletsInternal
```
protected void createAndSubmitCloudletsInternal(DatacenterBroker broker)
```
    Creates all the Cloudlets required by the experiment and submits them to a Broker. This the entry-point for Cloudlets creation.
    
    Parameters:
    
    broker - broker to submit Cloudlets to
  - createHosts
```
protected final List<Host> createHosts()
```
  - createHost
```
protected abstract Host createHost(int id)
```
  - getRunner
```
public ExperimentRunner getRunner()
```
    Gets the object that is in charge to run the experiment.
    
    Returns:
  - getBrokerList
```
public List<DatacenterBroker> getBrokerList()
```
    Gets the list of created DatacenterBrokers.
    
    Returns:
  - setAfterExperimentBuild
```
public <T extends Experiment> Experiment setAfterExperimentBuild(Consumer<T> afterExperimentBuild)
```
    Sets a Consumer that will be called after the simulation scenario is built, which is before starting the simulation.
    Setting a Consumer object is optional.
    
    Type Parameters:
    
    T - the class of the experiment
    
    Parameters:
    
    afterExperimentBuild - the afterExperimentBuild to set
    
    Returns:
  - setAfterExperimentFinish
```
public <T extends Experiment> Experiment setAfterExperimentFinish(Consumer<T> afterExperimentFinishConsumer)
```
    Sets a Consumer object that will receive the experiment instance after the experiment finishes executing and performs some post-processing tasks. These tasks are defined by the developer using the current class and can include collecting data for statistical analysis.
    Setting a Consumer object is optional.
    
    Type Parameters:
    
    T - the class of the experiment
    
    Parameters:
    
    afterExperimentFinishConsumer - a Consumer instance to set.
    
    Returns:
  - getSimulation
```
public final CloudSim getSimulation()
```
  - getBrokersNumber
```
public int getBrokersNumber()
```
    Gets the number of brokers to create.
    
    Returns:
  - setBrokersNumber
```
public Experiment setBrokersNumber(int brokersNumber)
```
    Sets the number of brokers to create.
    
    Parameters:
    
    brokersNumber - the value to set
  - getDatacenterList
```
public List<DatacenterSimple> getDatacenterList()
```
  - getSeed
```
public long getSeed()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setVmsByBrokerFunction
```
public final void setVmsByBrokerFunction(Function<DatacenterBroker,Integer> vmsByBrokerFunction)
```
    Sets a Function that receives a DatacenterBroker and returns the number of Vms to create for that broker. If you want all brokers to have the same amount of VMs, you can give a lambda expression such as broker -> NUMER_OF_VMS_TO_CREATE.
    
    Parameters:
    
    vmsByBrokerFunction - the Function to set
  - getVmsByBrokerFunction
```
protected Function<DatacenterBroker,Integer> getVmsByBrokerFunction()
```
    Gets a Function that receives a DatacenterBroker and returns the number of Vms to create for that broker.
  - setHostsNumber
```
protected final void setHostsNumber(int hostsNumber)
```
  - getDatacentersNumber
```
public int getDatacentersNumber()
```
  - setDatacentersNumber
```
public void setDatacentersNumber(int datacentersNumber)
```
  - setVmAllocationPolicySupplier
```
public void setVmAllocationPolicySupplier(Supplier<VmAllocationPolicy> vmAllocationPolicySupplier)
```
  - print
```
public void print(String msg)
```
    Prints a message only if isVerbose().
    
    Parameters:
    
    msg - the message to print
  - print
```
public void print(String format,
                  Object... args)
```
    Prints a formatted message only if isVerbose().
    
    Parameters:
    
    format - the message format
    
    args - the values to print
  - println
```
public void println()
```
    Prints a line break only if isVerbose().
  - println
```
public void println(String msg)
```
    Prints a message and a line break only if isVerbose().
    
    Parameters:
    
    msg - the message to print
  - println
```
public void println(String format,
                    Object... args)
```
    Prints a formatted message and a line break only if isVerbose().
    
    Parameters:
    
    format - the message format
    
    args - the values to print

Class Experiment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hostsNumber

Constructor Detail

Experiment

Experiment

Experiment

Method Detail

getCloudletList

getVmList

setVerbose

getIndex

isNotVerbose

isVerbose

run

printResults

build

createDatacenter

createBrokers

createBroker

createCloudlets

createCloudlet

createVms

createVm

nextVmId

nextCloudletId

createAndSubmitCloudletsInternal

createHosts

createHost

getRunner

getBrokerList

setAfterExperimentBuild

setAfterExperimentFinish

getSimulation

getBrokersNumber

setBrokersNumber

getDatacenterList

getSeed

toString

setVmsByBrokerFunction

getVmsByBrokerFunction

setHostsNumber

getDatacentersNumber

setDatacentersNumber

setVmAllocationPolicySupplier

print

print

println

println

println