ikr.simlib.statistics.counter

Class CounterStatistic

java.lang.Object

ikr.simlib.statistics.Statistic

ikr.simlib.statistics.counter.CounterStatistic

All Implemented Interfaces:

Printable

Direct Known Subclasses:

StdCounterStatistic

public abstract class CounterStatistic
extends Statistic
implements Printable

The classes CounterStatistic or StdCounterStatistic add up measured values (e.g., number of messages that have passed a certain port) of the type long during a batch with the help of the method 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
• Sum of all measured values in all batches (getNumberOfEvents())
• Sum of all measured values in the current batch ( getNumberOfBatchEvents())
• 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

bmin

Minimum of the number of registered values in a batch

bmin

Minimum of the number of registered values in a batch

bmax

Maximum of the number of registered values in a batch

bnumberofevents

Sum of the registered values in the last batch

sum

Sum of all registered values

numberofbatches

Number of all past batches

Field Summary

Fields inherited from class ikr.simlib.statistics.Statistic

sampleIndex, simNode, traceWriter

Constructor Summary

Constructors

Constructor and Description
CounterStatistic(SimNode ownNode)

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	getConfidenceInterval()
abstract double	getMaximum()
abstract double	getMean()
abstract double	getMinimum()
abstract long	getNumberOfBatches()
abstract long	getNumberOfBatchEvents()
abstract long	getNumberOfEvents()
java.lang.String	getResultTypeName()
abstract double	getStandardDeviation()
void	printResults(ResultType type, PrintResultWriter writer)
void	update() Basic update method, that triggers the output of trace entries
abstract void	update(long sample)

Methods inherited from class ikr.simlib.statistics.Statistic

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CounterStatistic

public CounterStatistic(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(long sample)

update

public final void update()

Description copied from class: Statistic

Basic update method, that triggers the output of trace entries

Overrides:

update in class Statistic

getMaximum

public abstract double getMaximum()

getMinimum

public abstract double getMinimum()

getMean

public abstract double getMean()

getNumberOfEvents

public abstract long getNumberOfEvents()

getNumberOfBatchEvents

public abstract long getNumberOfBatchEvents()

getNumberOfBatches

public abstract long getNumberOfBatches()

getConfidenceInterval

public abstract double getConfidenceInterval()

getStandardDeviation

public abstract double getStandardDeviation()