Experiment

java.lang.Object

org.palladiosimulator.protocom.framework.java.ee.api.http.Experiment

public class Experiment extends Object

API class for controlling experiments and experiment iterations.

Constructor Summary

Constructors

Constructor

Description

Experiment()
Method Summary

Modifier and Type

Method

Description

javax.ws.rs.core.Response

startExperiment(String name)

Starts an experiment with the specified name.

void

startIteration(String id)

Starts an experiment iteration.

javax.ws.rs.core.Response

stopExperiment()

Stops the currently running experiment.

void

stopIteration(String id)

Stops an experiment iteration.

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

Constructor Details
- Experiment
  
  public Experiment()
Method Details
- startExperiment
  
  public javax.ws.rs.core.Response startExperiment(String name)
  
  Starts an experiment with the specified name.
  
  Parameters:
  
  name - the name of the experiment
  
  Returns:
  
  an HTTP 204 response if the experiment was started successfully
- stopExperiment
  
  public javax.ws.rs.core.Response stopExperiment()
  
  Stops the currently running experiment.
  
  Returns:
  
  an HTTP 204 response if the experiment was stopped successfully
- startIteration
  
  public void startIteration(String id)
  
  Starts an experiment iteration.
  
  Parameters:
  
  id - the ID of the iteration
- stopIteration
  
  public void stopIteration(String id)
  
  Stops an experiment iteration.
  
  Parameters:
  
  id - the ID of the iteration