ikr.simlib.statistics.counter

Class StdCounterStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.counter.CounterStatistic

ikr.simlib.statistics.counter.StdCounterStatistic

All Implemented Interfaces:

BatchExportable, Printable

public class StdCounterStatistic
extends CounterStatistic
implements BatchExportable

StdCounterStatistic provides an implementation for a counter statistic. For printing the results it defines the following keywords:

mean

Mean of all batch sums

cintmean

Confidence interval of mean

max

Maximum batch sum

min

Minimum batch sum

bnumberofevents

Number of events in current batch

sum

Sum of passed events in all batches

numberofbatches

Number of passed Batches

Field Summary

Fields

Modifier and Type	Field and Description
protected Range	measuresRange
protected Summation	measuresSummation
protected long	sum

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
StdCounterStatistic(java.lang.String name, SimNode parentNode)

Method Summary

Methods

Modifier and Type	Method and Description
void	computeMeasures(int batchNumber)
void	exportBatch(ResultWriter writer) Exports the batch state to a result writer.
double	getConfidenceInterval()
double	getMaximum()
double	getMean()
double	getMinimum()
long	getNumberOfBatches()
long	getNumberOfBatchEvents()
long	getNumberOfEvents()
double	getStandardDeviation()
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	update(long sample)

Methods inherited from class ikr.simlib.statistics.counter.CounterStatistic

getResultTypeName, printResults, update

Methods inherited from class ikr.simlib.statistics.Statistic

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

Methods inherited from class java.lang.Object

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

Field Detail

sum

protected long sum

measuresSummation

protected final Summation measuresSummation

measuresRange

protected final Range measuresRange

Constructor Detail

StdCounterStatistic

public StdCounterStatistic(java.lang.String name,
                   SimNode parentNode)

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

getConfidenceInterval

public double getConfidenceInterval()

Specified by:

getConfidenceInterval in class CounterStatistic

getStandardDeviation

public double getStandardDeviation()

Specified by:

getStandardDeviation in class CounterStatistic

getMaximum

public double getMaximum()

Specified by:

getMaximum in class CounterStatistic

getMean

public double getMean()

Specified by:

getMean in class CounterStatistic

getMinimum

public double getMinimum()

Specified by:

getMinimum in class CounterStatistic

getNumberOfBatchEvents

public long getNumberOfBatchEvents()

Specified by:

getNumberOfBatchEvents in class CounterStatistic

getNumberOfBatches

public long getNumberOfBatches()

Specified by:

getNumberOfBatches in class CounterStatistic

getNumberOfEvents

public long getNumberOfEvents()

Specified by:

getNumberOfEvents in class CounterStatistic

update

public void update(long sample)

Specified by:

update in class CounterStatistic

computeMeasures

public void computeMeasures(int batchNumber)

Specified by:

computeMeasures in class Statistic

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