ikr.simlib.statistics

Class Statistic

java.lang.Object

ikr.simlib.statistics.Statistic

Direct Known Subclasses:

AutoCorrelationStatistic, BoundaryStatistic, CondMeanStatistic, CondProbabilityStatistic, CorrelationStatistic, CounterStatistic, DistributionStatistic, FairnessStatistic, IntegralStatistic, MedianStatistic, ProbabilityStatistic, RateStatistic, SampleStatistic, VTStatistic, WeightedDistStatistic, WeightedMeanStatistic

public abstract class Statistic
extends java.lang.Object

Statistic is an abstract base class that controls measurement and printing. For use within a "light" version it provides the methods resetStatistic(), resetBatchStatistic(), and computeMeasures(int) as an interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	sampleIndex
protected StdSimNode	simNode
protected ResultWriter	traceWriter Writer object to write trace entries

Constructor Summary

Constructors

Constructor and Description
Statistic(java.lang.String name, SimNode parent)

Method Summary

Methods

Modifier and Type	Method and Description
void	addResultTag(ResultKeyword keyword, java.lang.String value) Adds a tag (keyword and value) to the output of this statistic in the final results file.
void	addResultTag(java.lang.String keyword, java.lang.String value) Convenience method which creates a new result keyword from a string.
abstract void	computeMeasures(int batchNumber)
void	disableTracing() Un-sets the writer object and disables tracing
void	enableTracing(ResultWriter writer) Sets the writer object and enables tracing
void	handleInitSimulation()
void	handleStartBatch(int batchNumber)
void	handleStartTransientPhase()
void	handleStopBatch(int batchNumber)
void	handleStopTransientPhase()
protected void	printComments(PrintResultWriter writer)
abstract void	resetBatchStatistic() only between batches
abstract void	resetStatistic() reset complete statistic
protected void	update() Basic update method, that triggers the output of trace entries
protected void	writeTraceEntry() Abstract method to be overwritten by derived statistics to output trace entries

Methods inherited from class java.lang.Object

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

Field Detail

simNode

protected final StdSimNode simNode

traceWriter

protected ResultWriter traceWriter

Writer object to write trace entries

sampleIndex

protected int sampleIndex

Constructor Detail

Statistic

public Statistic(java.lang.String name,
         SimNode parent)

Method Detail

resetStatistic

public abstract void resetStatistic()

reset complete statistic

resetBatchStatistic

public abstract void resetBatchStatistic()

only between batches

computeMeasures

public abstract void computeMeasures(int batchNumber)

addResultTag

public void addResultTag(ResultKeyword keyword,
                java.lang.String value)

Adds a tag (keyword and value) to the output of this statistic in the final results file. This can be used to write static, user-specific data to the results file. To write, e.g. the unit of a statistic, call addResultTag(ResultKeywords.UNIT, "bytes").

Parameters:

keyword - the key

value - the value

addResultTag

public void addResultTag(java.lang.String keyword,
                java.lang.String value)

Convenience method which creates a new result keyword from a string.

Parameters:

keyword - the key

value - the value

See Also:

addResultTag(ResultKeyword, String)

printComments

protected void printComments(PrintResultWriter writer)

handleInitSimulation

public void handleInitSimulation()

handleStartBatch

public void handleStartBatch(int batchNumber)

handleStartTransientPhase

public void handleStartTransientPhase()

handleStopBatch

public void handleStopBatch(int batchNumber)

handleStopTransientPhase

public void handleStopTransientPhase()

update

protected void update()

Basic update method, that triggers the output of trace entries

enableTracing

public void enableTracing(ResultWriter writer)

Sets the writer object and enables tracing

Parameters:

writer - ResultWriter connected to trace file

disableTracing

public void disableTracing()

Un-sets the writer object and disables tracing

writeTraceEntry

protected void writeTraceEntry()

Abstract method to be overwritten by derived statistics to output trace entries