Package net.simplace.sim.io.output

Class FWSimStatisticVariable

java.lang.Object

net.simplace.sim.io.output.FWSimStatisticVariable

Direct Known Subclasses:

DefaultSimStatistic

public abstract class FWSimStatisticVariable
extends Object

Author:

Andreas Enders

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FWSimStatisticVariable(org.jdom2.Element aStatElement, FWSimOutputAdapter aFwSimOutputAdapter)	hidden constructor

Method Summary

Modifier and Type	Method	Description
protected abstract Double	calculate(Object[] aDataArray, Object[] aDataArray2, String aStatMode)	implement this method to calculate the statistical value for the given mode
Double	calculateStatistics(Object[] aDataArray, Object[] aDataArray2)	calculates the statistics for the given mode
static FWSimStatisticVariable	createStatistic(org.jdom2.Element aStatElement, FWSimOutputAdapter aFwSimOutputAdapter)	reads from sources like
String	getDescription()
String	getStatID()
String	getStatMode()
String	getStatObsVarID()
String	getStatSimVarID()
String	getUnit()
org.jdom2.Element	toXML()

Methods inherited from class java.lang.Object

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

Constructor Details

FWSimStatisticVariable

protected FWSimStatisticVariable(org.jdom2.Element aStatElement,
 FWSimOutputAdapter aFwSimOutputAdapter)

hidden constructor

Parameters:

aStatElement -

aFwSimOutputAdapter -

Method Details

createStatistic

public static FWSimStatisticVariable createStatistic(org.jdom2.Element aStatElement,
 FWSimOutputAdapter aFwSimOutputAdapter)

reads from sources like

Parameters:

aStatElement -

aFwSimOutputAdapter -

Returns:

the newly created statistics container

calculateStatistics

public Double calculateStatistics(Object[] aDataArray,
 Object[] aDataArray2)

calculates the statistics for the given mode

Parameters:

aDataArray -

aDataArray2 -

Returns:

calculate

protected abstract Double calculate(Object[] aDataArray,
 Object[] aDataArray2,
 String aStatMode)

implement this method to calculate the statistical value for the given mode

Parameters:

aDataArray -

aDataArray2 -

aStatMode -

Returns:

getStatID

public String getStatID()

Returns:

the statID

getStatSimVarID

public String getStatSimVarID()

Returns:

the statSimVarID

getStatObsVarID

public String getStatObsVarID()

Returns:

the statObsVarID

getStatMode

public String getStatMode()

Returns:

the statMode

getUnit

public String getUnit()

Returns:

the statMode

getDescription

public String getDescription()

Returns:

the statMode

toXML

public org.jdom2.Element toXML()

Returns:

the Element of the variable with all needed values