ikr.simlib.statistics.rate

Class StdRateStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.rate.RateStatistic

ikr.simlib.statistics.rate.StdRateStatistic

All Implemented Interfaces:

BatchExportable, Printable

public class StdRateStatistic
extends RateStatistic
implements BatchExportable

StdRateStatistic extends RateStatistic and provides an implementation for a rate statistic. Thereby "rate" measures that rate in e.g. units whereas "samplerate" considers the rate of samples (the amount passed to Update(amount) is not considered)

For printing results it defines the following keywords:

rate

Mean of all rates (amount/time) in all batches

cintrate

Confidence interval to mean rates

samplerate

Mean of all rates (samples/time) in all batches

cintsamplerate

Confidence interval to mean rates

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
StdRateStatistic(SimNode ownNode)

Method Summary

Methods

Modifier and Type	Method and Description
void	computeMeasures(int batchNumber)
void	computeMeasures(int batchNumber, double currentTime) For light version
void	exportBatch(ResultWriter writer) Exports the batch state to a result writer.
double	getBatchRate()
double	getBatchSampleRate()
double	getRate()
double	getRateConfInterval()
double	getSampleRate()
double	getSampleRateConfInterval()
void	importBatch(ResultReader reader) Imports the state of a batch from the result reader.
void	resetBatchStatistic() only between batches
void	resetStatistic() reset complete statistic
void	resetStatistic(double currentTime) For light version
void	update(double amount)

Methods inherited from class ikr.simlib.statistics.rate.RateStatistic

getResultTypeName, printResults

Methods inherited from class ikr.simlib.statistics.Statistic

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StdRateStatistic

public StdRateStatistic(SimNode ownNode)

Method Detail

exportBatch

public void exportBatch(ResultWriter writer)
                 throws ResultException

Description copied from interface: BatchExportable

Exports the batch state to a result writer. Everything written to the result writer has to be read in the same order in importBatch despite the keywords.

Specified by:

exportBatch in interface BatchExportable

Parameters:

writer - the result writer which preserves the state

Throws:

ResultException - if any exception occurs while writing a result to the writer

importBatch

public void importBatch(ResultReader reader)
                 throws ResultException

Description copied from interface: BatchExportable

Imports the state of a batch from the result reader. The exported results have to read in the same order as written in exportBatch despite the keywords.

Specified by:

importBatch in interface BatchExportable

Parameters:

reader - the result reader which contains the batch state

Throws:

ResultException - if any exception occurs while reading a result from the reader

getRate

public double getRate()

Specified by:

getRate in class RateStatistic

getRateConfInterval

public double getRateConfInterval()

Specified by:

getRateConfInterval in class RateStatistic

getSampleRate

public double getSampleRate()

Specified by:

getSampleRate in class RateStatistic

getSampleRateConfInterval

public double getSampleRateConfInterval()

Specified by:

getSampleRateConfInterval in class RateStatistic

update

public void update(double amount)

Specified by:

update in class RateStatistic

getBatchRate

public double getBatchRate()

Specified by:

getBatchRate in class RateStatistic

getBatchSampleRate

public double getBatchSampleRate()

Specified by:

getBatchSampleRate in class RateStatistic

computeMeasures

public void computeMeasures(int batchNumber)

Specified by:

computeMeasures in class Statistic

computeMeasures

public void computeMeasures(int batchNumber,
                   double currentTime)

Description copied from class: RateStatistic

For light version

Specified by:

computeMeasures in class RateStatistic

resetBatchStatistic

public void resetBatchStatistic()

Description copied from class: Statistic

only between batches

Specified by:

resetBatchStatistic in class Statistic

resetStatistic

public void resetStatistic()

Description copied from class: Statistic

reset complete statistic

Specified by:

resetStatistic in class Statistic

resetStatistic

public void resetStatistic(double currentTime)

Description copied from class: RateStatistic

For light version

Specified by:

resetStatistic in class RateStatistic