ikr.simlib.statistics.batchsum

Class BatchSumStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.batchsum.BatchSumStatistic

All Implemented Interfaces:

Printable, ResultTaggable, UnweightedSampleCollector<java.lang.Long>

Direct Known Subclasses:

StdBatchSumStatistic

public abstract class BatchSumStatistic
extends Statistic
implements Printable, UnweightedSampleCollector<java.lang.Long>

The classes BatchSumStatistic or StdBatchSumStatistic add up measured values (e.g., number of bytes that have passed a certain port) of the type long during a batch with the help of the method Statistic.update().

The following functions are available for evaluation:

• Mean value of batch sums (getMean()) including a confidence interval (getConfidenceInterval())
• Value range (getMinimum() and getMaximum()) of the batch sums
• Number of calls to the update() method over all batches ( getNumberOfEvents())
• Number of batches (getNumberOfBatches())

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

mean

mean value of the registered values per batch

cintmean

confidence interval of the mean values in +/- notation

numberofevents

number of calls to the update() method over all batches

numberofbatches

number of all batches

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
BatchSumStatistic(SimNode ownNode)

Method Summary

Methods

Modifier and Type	Method and Description
abstract long	getBatchSum()
abstract double	getConfidenceInterval()
abstract double	getMaximum()
abstract double	getMean()
abstract double	getMinimum()
abstract long	getNumberOfBatches()
abstract long	getNumberOfBatchEvents()
abstract long	getNumberOfEvents()
abstract double	getStandardDeviation()
void	printResults(ResultType type, PrintResultWriter writer)
abstract void	update(long sample)
void	update(java.lang.Long value)

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

BatchSumStatistic

public BatchSumStatistic(SimNode ownNode)

Method Detail

printResults

public void printResults(ResultType type,
                PrintResultWriter writer)
                  throws PrintException

Specified by:

printResults in interface Printable

Throws:

PrintException

update

public abstract void update(long sample)

update

public void update(java.lang.Long value)

Specified by:

update in interface UnweightedSampleCollector<java.lang.Long>

getMaximum

public abstract double getMaximum()

getMinimum

public abstract double getMinimum()

getMean

public abstract double getMean()

getNumberOfEvents

public abstract long getNumberOfEvents()

getBatchSum

public abstract long getBatchSum()

getNumberOfBatchEvents

public abstract long getNumberOfBatchEvents()

getNumberOfBatches

public abstract long getNumberOfBatches()

getConfidenceInterval

public abstract double getConfidenceInterval()

getStandardDeviation

public abstract double getStandardDeviation()