com.qbpsimulator.engine.logger

Class KpiCalculator

java.lang.Object

com.qbpsimulator.engine.logger.KpiCalculator

All Implemented Interfaces:

IProcessLogger, IResultsProvider

public class KpiCalculator
extends Object
implements IProcessLogger, IResultsProvider

Main class that calculates statistics for processes and its resources and elements

Constructor Summary

Constructors

Constructor and Description
KpiCalculator(BPSimulator simulationInstance)
KpiCalculator(BPSimulator simulationInstance, String csvFileName)

Method Summary

Modifier and Type	Method and Description
void	finish() Simulation finished.
DoubleStatsValue	getAccumulatedDuration() Gets accumulated duration stats
ActivityStats	getActivityStats(Activity element) Return collected statistics for an activity
List<ActivityStats>	getAllActivityStats() Returns all activity stats
List<Activity>	getAllElements() Returns sorted by name list of all elements in the process model
List<ResourceStats>	getAllResourceStats() Gets all resource stats
double	getAverageCycleTime() Deprecated.
double	getAverageCycleTimeInTimetable() Deprecated.
double	getAverageWaitingTime() Deprecated.
int	getCompletedElements() Returns number of completed elements
int	getCompletedProcessInstances() Returns number of completed process instances
DoubleStatsValue	getCost() Get cost stats
String	getCsvFileName()
DoubleStatsValue	getCycleTime() Gets cycle time stats
DoubleStatsValue	getCycleTimeInTimetable() Gets cycle time in timetable stats
int	getEnabledElements() Returns number of enabled elements
int	getFirstProcessInstanceIndex() Gets first process instance number
static double[]	getHistogramData(double[] dataset, int bars)
int	getLastProcessInstanceIndex() Gets last process instance number
double	getMaxProcessCost() Deprecated.
double	getMaxProcessCycleTime() Deprecated.
double	getMaxProcessCycleTimeInTimetable() Deprecated.
double	getMaxProcessDuration() Deprecated.
double	getMaxProcessWaitingTime() Deprecated.
double	getMinProcessCost() Deprecated.
double	getMinProcessCycleTime() Deprecated.
double	getMinProcessCycleTimeInTimetable() Deprecated.
double	getMinProcessDuration() Deprecated.
double	getMinProcessWaitingTime() Deprecated.
double[]	getProcessCosts() Deprecated.
double[]	getProcessCycleTimes() Deprecated.
double[]	getProcessCycleTimesInTimetable() Deprecated.
double[]	getProcessDurations() Deprecated.
int	getProcessInstanceCount() Gets number of process instances
double[]	getProcessWaitingTimes() Deprecated.
double	getResourceUtilization(Resource resource) Returns the resource utilization for a given resource type.
double	getScenarioCycleTime() Returns the scenario cycle time in seconds
BPSimulator	getSimulator() Returns an instance of the simulator
int	getStartedElements() Returns number of started elements
int	getStartedProcessInstances() Returns number of started process instances
double	getTotalCost() Deprecated.
double	getTotalCycleTime() Deprecated.
double	getTotalDuration() Deprecated.
DoubleStatsValue	getWaitingTime() Gets waiting time stats
void	init() Initialize logger
void	logCollaboration(ProcessActivity activity, Collaboration collaboration) Collaboration between processes.
void	logElementCompletion(ProcessActivity activity) Completion of a process activity
void	logElementEnabled(ProcessActivity activity) Enablement of a process activity
void	logElementRescinded(ProcessActivity activity) Activity rescinded (e.g.
void	logElementStarted(ProcessActivity activity) Process activity started
void	logElementTerminated(ProcessActivity activity) Activity terminated (e.g.
void	logEnabledPending(ProcessActivity activity) Collaboration received.
void	logMessageRegistered(ProcessActivityCollaboration newActivity) Message registered with the id from another process
void	logProcessEnabled(ProcessInstance process) Process instance started.
void	logProcessEnd(ProcessInstance process) Process instance finished.
void	logResourceAvailable(ProcessActivity activity, int totalAvailable) Resource is available for activity.
void	logResourceUnavailable(ProcessActivity activity) Resource is not available for activity
void	printStats()
boolean	saveToCSV() Deprecated. Use CSVWriter
void	setCsvFileName(String csvFileName)

Methods inherited from class java.lang.Object

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

Constructor Detail

KpiCalculator

public KpiCalculator(BPSimulator simulationInstance)

KpiCalculator

public KpiCalculator(BPSimulator simulationInstance,
                     String csvFileName)

Method Detail

logElementCompletion

public void logElementCompletion(ProcessActivity activity)

Description copied from interface: IProcessLogger

Completion of a process activity

Specified by:

logElementCompletion in interface IProcessLogger

Parameters:

activity - related activity

logElementEnabled

public void logElementEnabled(ProcessActivity activity)

Description copied from interface: IProcessLogger

Enablement of a process activity

Specified by:

logElementEnabled in interface IProcessLogger

Parameters:

activity - related activity

logElementStarted

public void logElementStarted(ProcessActivity activity)

Description copied from interface: IProcessLogger

Process activity started

Specified by:

logElementStarted in interface IProcessLogger

Parameters:

activity - related activity

logElementTerminated

public void logElementTerminated(ProcessActivity activity)

Description copied from interface: IProcessLogger

Activity terminated (e.g. by interrupting event or terminate event)

Specified by:

logElementTerminated in interface IProcessLogger

Parameters:

activity - related activity

logElementRescinded

public void logElementRescinded(ProcessActivity activity)

Description copied from interface: IProcessLogger

Activity rescinded (e.g. by linked exclusive activities)

Specified by:

logElementRescinded in interface IProcessLogger

Parameters:

activity - related activity

logProcessEnd

public void logProcessEnd(ProcessInstance process)

Description copied from interface: IProcessLogger

Process instance finished.

Specified by:

logProcessEnd in interface IProcessLogger

Parameters:

process - related instance

logProcessEnabled

public void logProcessEnabled(ProcessInstance process)

Description copied from interface: IProcessLogger

Process instance started.

Specified by:

logProcessEnabled in interface IProcessLogger

Parameters:

process - related instance

logCollaboration

public void logCollaboration(ProcessActivity activity,
                             Collaboration collaboration)

Description copied from interface: IProcessLogger

Collaboration between processes.

Specified by:

logCollaboration in interface IProcessLogger

Parameters:

activity - associated activity

collaboration - associated collaboration

logEnabledPending

public void logEnabledPending(ProcessActivity activity)

Description copied from interface: IProcessLogger

Collaboration received. Activity set to pending and waiting for a call.

Specified by:

logEnabledPending in interface IProcessLogger

Parameters:

activity - related activity

logResourceAvailable

public void logResourceAvailable(ProcessActivity activity,
                                 int totalAvailable)

Description copied from interface: IProcessLogger

Resource is available for activity.

Specified by:

logResourceAvailable in interface IProcessLogger

Parameters:

activity - related activity

totalAvailable - number on free resources

logResourceUnavailable

public void logResourceUnavailable(ProcessActivity activity)

Description copied from interface: IProcessLogger

Resource is not available for activity

Specified by:

logResourceUnavailable in interface IProcessLogger

Parameters:

activity - related activity

printStats

public void printStats()

finish

public void finish()

Description copied from interface: IProcessLogger

Simulation finished.

Specified by:

finish in interface IProcessLogger

saveToCSV

public boolean saveToCSV()

Deprecated. Use CSVWriter

getAllElements

public List<Activity> getAllElements()

Returns sorted by name list of all elements in the process model

Returns:

getAllActivityStats

public List<ActivityStats> getAllActivityStats()

Returns all activity stats

Specified by:

getAllActivityStats in interface IResultsProvider

Returns:

getActivityStats

public ActivityStats getActivityStats(Activity element)

Return collected statistics for an activity

Parameters:

element - activity for which to return statistics

Returns:

null if there were no statistics collected for the activity

getEnabledElements

public int getEnabledElements()

Returns number of enabled elements

Returns:

getCompletedElements

public int getCompletedElements()

Returns number of completed elements

Returns:

getStartedElements

public int getStartedElements()

Returns number of started elements

Returns:

getTotalDuration

public double getTotalDuration()

Deprecated.

Returns total duration of all process instances

Returns:

getMinProcessDuration

public double getMinProcessDuration()

Deprecated.

Returns minimum duration of a process instance

Returns:

getMaxProcessDuration

public double getMaxProcessDuration()

Deprecated.

Returns maximum duration of a process instance

Returns:

getAverageWaitingTime

public double getAverageWaitingTime()

Deprecated.

Return average waiting time of a process

Returns:

getMinProcessWaitingTime

public double getMinProcessWaitingTime()

Deprecated.

Returns minimum waiting time of a process instance

Returns:

getMaxProcessWaitingTime

public double getMaxProcessWaitingTime()

Deprecated.

Returns maximum waiting time of a process instance

Returns:

getMinProcessCycleTime

public double getMinProcessCycleTime()

Deprecated.

Returns minimum cycle time a process instance

Returns:

getMaxProcessCycleTime

public double getMaxProcessCycleTime()

Deprecated.

Returns maximum cycle time of a process instance

Returns:

getMinProcessCycleTimeInTimetable

public double getMinProcessCycleTimeInTimetable()

Deprecated.

Returns minimum cycle time a process instance

Returns:

getMaxProcessCycleTimeInTimetable

public double getMaxProcessCycleTimeInTimetable()

Deprecated.

Returns maximum cycle time of a process instance

Returns:

getMinProcessCost

public double getMinProcessCost()

Deprecated.

Returns minimum cost of a process instance

Returns:

getMaxProcessCost

public double getMaxProcessCost()

Deprecated.

Returns maximum cost of a process instance

Returns:

getTotalCost

public double getTotalCost()

Deprecated.

Returns total cost of the simulation

Returns:

getStartedProcessInstances

public int getStartedProcessInstances()

Returns number of started process instances

Returns:

getCompletedProcessInstances

public int getCompletedProcessInstances()

Returns number of completed process instances

Returns:

init

public void init()

Description copied from interface: IProcessLogger

Initialize logger

Specified by:

init in interface IProcessLogger

getProcessDurations

public double[] getProcessDurations()

Deprecated.

Returns array of all process durations

Returns:

getProcessWaitingTimes

public double[] getProcessWaitingTimes()

Deprecated.

Returns array of waiting times per process instances

Returns:

getProcessCosts

public double[] getProcessCosts()

Deprecated.

Returns array of all process costs

Returns:

getProcessCycleTimes

public double[] getProcessCycleTimes()

Deprecated.

Returns array of all process cycle times

Returns:

array of cycle times

getProcessCycleTimesInTimetable

public double[] getProcessCycleTimesInTimetable()

Deprecated.

Returns array of all process in timetable cycle times

Returns:

array of cycle times in timetable

getResourceUtilization

public double getResourceUtilization(Resource resource)

Returns the resource utilization for a given resource type. Can be called after simulation has finished.

Parameters:

resource - resource to get the utilization for

Returns:

resource utilization [0 - 1]

getHistogramData

public static double[] getHistogramData(double[] dataset,
                                        int bars)

getTotalCycleTime

public double getTotalCycleTime()

Deprecated.

Returns total cycle time of the simulation

Returns:

getAverageCycleTime

public double getAverageCycleTime()

Deprecated.

Return average cycle time of a process

Returns:

average cycle time

getAverageCycleTimeInTimetable

public double getAverageCycleTimeInTimetable()

Deprecated.

Return average cycle time of a process in timetable

Returns:

average cycle time in timetable

getCsvFileName

public String getCsvFileName()

Returns:

the csvFileName

setCsvFileName

public void setCsvFileName(String csvFileName)

Parameters:

csvFileName - the csvFileName to set

logMessageRegistered

public void logMessageRegistered(ProcessActivityCollaboration newActivity)

Description copied from interface: IProcessLogger

Message registered with the id from another process

Specified by:

logMessageRegistered in interface IProcessLogger

getSimulator

public BPSimulator getSimulator()

Returns an instance of the simulator

Returns:

getProcessInstanceCount

public int getProcessInstanceCount()

Description copied from interface: IResultsProvider

Gets number of process instances

Specified by:

getProcessInstanceCount in interface IResultsProvider

Returns:

getAllResourceStats

public List<ResourceStats> getAllResourceStats()

Description copied from interface: IResultsProvider

Gets all resource stats

Specified by:

getAllResourceStats in interface IResultsProvider

Returns:

getAccumulatedDuration

public DoubleStatsValue getAccumulatedDuration()

Description copied from interface: IResultsProvider

Gets accumulated duration stats

Specified by:

getAccumulatedDuration in interface IResultsProvider

Returns:

getCost

public DoubleStatsValue getCost()

Description copied from interface: IResultsProvider

Get cost stats

Specified by:

getCost in interface IResultsProvider

Returns:

getCycleTime

public DoubleStatsValue getCycleTime()

Description copied from interface: IResultsProvider

Gets cycle time stats

Specified by:

getCycleTime in interface IResultsProvider

Returns:

getCycleTimeInTimetable

public DoubleStatsValue getCycleTimeInTimetable()

Description copied from interface: IResultsProvider

Gets cycle time in timetable stats

Specified by:

getCycleTimeInTimetable in interface IResultsProvider

Returns:

getWaitingTime

public DoubleStatsValue getWaitingTime()

Description copied from interface: IResultsProvider

Gets waiting time stats

Specified by:

getWaitingTime in interface IResultsProvider

getFirstProcessInstanceIndex

public int getFirstProcessInstanceIndex()

Description copied from interface: IResultsProvider

Gets first process instance number

Specified by:

getFirstProcessInstanceIndex in interface IResultsProvider

Returns:

getLastProcessInstanceIndex

public int getLastProcessInstanceIndex()

Description copied from interface: IResultsProvider

Gets last process instance number

Specified by:

getLastProcessInstanceIndex in interface IResultsProvider

Returns:

getScenarioCycleTime

public double getScenarioCycleTime()

Description copied from interface: IResultsProvider

Returns the scenario cycle time in seconds

Specified by:

getScenarioCycleTime in interface IResultsProvider

Returns: