ikr.simlib.statistics.integral

Class IntegralStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.integral.IntegralStatistic

All Implemented Interfaces:

Printable

Direct Known Subclasses:

StdIntegralStatistic

public abstract class IntegralStatistic
extends Statistic
implements Printable

The classes IntegralStatistic or StdIntegralStatistic serve to record measured values, whose absolute value is not the only important factor, but also the duration of the value's appearance is of importance. Determining the utilization factor of a service unit (see Figure) or the average length of a queue are just a few examples.


Utilization of a service unit
The emphasis of time duration corresponds to integral creation by adding up the integral sections, that are created by each call of update(double, double) as a product of the returned measured value of the last update(double, double) call (with declaration of the system time) and the intermediate time interval. At the end of a batch this integral value is divided by the elapsed time since batch begin in order to obtain the mean value.

The following functions are available for evaluation:

• Time-emphasized mean value across all batches (getMean()) including a confidence interval (getConfidenceInterval())
• Value range (getMinimum() and getMaximum()) of returned measured values across all batches
• Time-emphasized mean value in reference to the current batch ( getBatchMean())

Results can be printed using the following keywords within a print format:

mean

Mean value of all batch integrals each divided by its own batch duration

cintmean

Confidence interval of the mean values in +/- notation

max

Greatest of all returned measured values during simulation

min

Smallest of all returned measured values during simulation

barea

Integral sum of the current batch divided by the duration of the batch

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
IntegralStatistic(SimNode ownNode)

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	getBatchMean()
abstract double	getConfidenceInterval()
abstract double	getMaximum()
abstract double	getMean()
abstract double	getMinimum()
java.lang.String	getResultTypeName()
void	printResults(ResultType type, PrintResultWriter writer)
abstract void	setStartValues(double time, double height)
abstract void	update(double time, double height)

Methods inherited from class ikr.simlib.statistics.Statistic

addResultTag, addResultTag, computeMeasures, disableTracing, enableTracing, handleInitSimulation, handleStartBatch, handleStartTransientPhase, handleStopBatch, handleStopTransientPhase, printComments, resetBatchStatistic, resetStatistic, update, writeTraceEntry

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegralStatistic

public IntegralStatistic(SimNode ownNode)

Method Detail

printResults

public void printResults(ResultType type,
                PrintResultWriter writer)

Specified by:

printResults in interface Printable

getResultTypeName

public java.lang.String getResultTypeName()

Specified by:

getResultTypeName in interface Printable

update

public abstract void update(double time,
          double height)

getMean

public abstract double getMean()

getMaximum

public abstract double getMaximum()

getMinimum

public abstract double getMinimum()

getBatchMean

public abstract double getBatchMean()

getConfidenceInterval

public abstract double getConfidenceInterval()

setStartValues

public abstract void setStartValues(double time,
                  double height)