org.jbpm.sim.def
Class JbpmSimulationExperiment

java.lang.Object
  org.jbpm.sim.def.JbpmSimulationExperiment

public class JbpmSimulationExperiment
extends java.lang.Object

This class represents a full blown jbpm simulation experiment, which can include several simulation scenarios, maybe to compare them. Every scenario inside the JbpmSimulationExperiment is executed in a DESMO-J experiment. So don't be confused about this two different definition of the term "experiment" in this area. The configuration is done with this XML:

Author:

bernd.ruecker@camunda.com

Field Summary

static int	HOURS
static int	MILLISECONDS
static int	MINUTES
static int	SECONDS

Constructor Summary

JbpmSimulationExperiment(java.lang.String name)

Method Summary

void	addScenario(JbpmSimulationScenario scenario)
java.lang.String	getCurrency()
java.lang.String	getName()
java.lang.String	getOutputPathName()
java.util.Date	getRealStartDate()
ExperimentReport	getReport()
double	getResetTime()
JbpmSimulationScenario	getScenario(java.lang.String name)
java.util.Collection	getScenarios()
long	getSeed()
ScenarioReport	getSimulationReportForScenario(java.lang.String scenarioName) retrieves the org.jbpm.sim.report.SimulationReport for the specified scenario.
double	getSimulationRunTime()
int	getTimeUnit()
double	getUnutilizedTimeCostFactor()
boolean	getWriteDesmojHtmlOutput()
boolean	isRememberEndedProcessInstances()
void	run() run the experiment and start simulation of all scenario's.
void	run(SimulationProgressListener listener) run the experiment and start simulation of all scenario's.
void	setCurrency(java.lang.String currency)
void	setOutputPathName(java.lang.String outputPathName)
void	setRealStartDate(java.util.Date realStartDate)
void	setRealStartDate(java.lang.String realStartTimeString)
void	setRememberEndedProcessInstances(boolean rememberEndedProcessInstances)
void	setResetTime(double resetTime)
void	setSeed(long seed)
void	setSimulationRunTime(double simulationRunTime)
void	setTimeUnit(int timeUnit)
void	setUnutilizedTimeCostFactor(double unutilizedTimeCostFactor)
void	setWriteDesmojHtmlOutput(boolean writeDesmojHtmlOutput)

Methods inherited from class java.lang.Object

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

Field Detail

MILLISECONDS

public static int MILLISECONDS

SECONDS

public static int SECONDS

MINUTES

public static int MINUTES

HOURS

public static int HOURS

Constructor Detail

JbpmSimulationExperiment

public JbpmSimulationExperiment(java.lang.String name)

Method Detail

addScenario

public void addScenario(JbpmSimulationScenario scenario)

run

public void run()

run the experiment and start simulation of all scenario's. Please note, that this can take some time and the method is blocking.

run

public void run(SimulationProgressListener listener)

run the experiment and start simulation of all scenario's. Please note, that this can take some time and the method is blocking.

getScenarios

public java.util.Collection getScenarios()

getScenario

public JbpmSimulationScenario getScenario(java.lang.String name)

getSimulationReportForScenario

public ScenarioReport getSimulationReportForScenario(java.lang.String scenarioName)

retrieves the org.jbpm.sim.report.SimulationReport for the specified scenario. The SimulationResult is null in case the simulation hasn't run yet.

Parameters:

scenarioName - the name of the scenario

Returns:

the simulation report

setSimulationRunTime

public void setSimulationRunTime(double simulationRunTime)

setRealStartDate

public void setRealStartDate(java.lang.String realStartTimeString)

setRealStartDate

public void setRealStartDate(java.util.Date realStartDate)

setTimeUnit

public void setTimeUnit(int timeUnit)

setOutputPathName

public void setOutputPathName(java.lang.String outputPathName)

getName

public java.lang.String getName()

getSimulationRunTime

public double getSimulationRunTime()

getRealStartDate

public java.util.Date getRealStartDate()

getTimeUnit

public int getTimeUnit()

getOutputPathName

public java.lang.String getOutputPathName()

getWriteDesmojHtmlOutput

public boolean getWriteDesmojHtmlOutput()

setWriteDesmojHtmlOutput

public void setWriteDesmojHtmlOutput(boolean writeDesmojHtmlOutput)

getReport

public ExperimentReport getReport()

getCurrency

public java.lang.String getCurrency()

setCurrency

public void setCurrency(java.lang.String currency)

isRememberEndedProcessInstances

public boolean isRememberEndedProcessInstances()

setRememberEndedProcessInstances

public void setRememberEndedProcessInstances(boolean rememberEndedProcessInstances)

getUnutilizedTimeCostFactor

public double getUnutilizedTimeCostFactor()

setUnutilizedTimeCostFactor

public void setUnutilizedTimeCostFactor(double unutilizedTimeCostFactor)

getResetTime

public double getResetTime()

setResetTime

public void setResetTime(double resetTime)

getSeed

public long getSeed()

setSeed

public void setSeed(long seed)