Statistic (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.extensions.visualization2d.engine.model.Statistic

All Implemented Interfaces:

Basic, ClassBasic
```
public class Statistic
extends java.lang.Object
implements Basic
```
Class to store a time series(typeData = DATA_TimeSeries) or a observation series (typeData = DATA_Observations). In a time series, for every observed time, you have exactly one value. In a observation series, you can have more than one value at one time. E.g. At one time, you have 2 events with different values. On the fly, the indexes: INDEX_None, INDEX_Min_Max, INDEX_Mean_StdDev are supported. For visualization you must use the class StatisticGrafic. The data are stored in data structures of the jFreeChart Library. For histogram support the number of histogram-cells specified by constructor must greater than 0.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

christian.mueller@th-wildau.de For information about subproject: desmoj.extensions.visualization2d please have a look at: http://www.th-wildau.de/cmueller/Desmo-J/Visualization2d/ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DATA_Observations`
`static int`	`DATA_TimeSeries`
`static int`	`INDEX_Mean_StdDev`
`static int`	`INDEX_Min_Max`
`static int`	`INDEX_None`

Constructor Summary

Constructors
Constructor and Description
`Statistic(Model model, java.lang.String id, int typeData, int typeIndex, boolean aggregate, long timeLow, long timeHigh, double valueLow, double valueHigh, int histogramCells)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Grafic`	`createGrafic(java.lang.String viewId, int x, int y, int animationType, boolean isIntValue, java.awt.Dimension deltaSize, boolean infopane)` build an instance of StatisticGrafic
`long`	`getFirstTime()` get first observation time
`Grafic`	`getGrafic()` get an existing StatisticGrafic instance.
`XIntervalSeries`	`getHistogram()` get histogram in jFreeChart data structure.
`double`	`getHistogramHigh()` get highest border of highest histogram cell
`double`	`getHistogramIntervalLength()` get length of one histogram cell
`double`	`getHistogramLow()` get lowest border of lowest histogram cell
`java.lang.String`	`getId()`
`long`	`getLastTime()` get last observation time
`double`	`getLastValue()` get last stored value
`double`	`getMax()` get max value
`double`	`getMean()` get mean for typeData = Statistic.DATA_Observations, all values have the same weight.
`double`	`getMin()` get min value
`Model`	`getModel()`
`java.lang.String`	`getName()`
`long`	`getObservationLength()` get length of observation time
`XYSeries`	`getObservationSerie()` get observation series in jFreeChart data structure.
`double`	`getStdDev()` get standard deviation for typeData = Statistic.DATA_Observations, all values have the same weight.
`long`	`getTimeHigh()` get high value of time axis
`long`	`getTimeLow()` get low value of time axis
`TimeSeries`	`getTimeSerie()` get time series in jFreeChart data structure.
`int`	`getTypeData()` gets TypeData.
`int`	`getTypeIndex()` gets TypeData.
`double`	`getValueHigh()` get high value of value axis
`double`	`getValueLow()` get low value of value axis
`boolean`	`hasHistogramSupport()` when no. of histogram cells greater zero
`boolean`	`hasValue()` true when one or more points stored.
`void`	`reset()` reset statistic object, used by warnup called from Model.resetStatistic(...)
`void`	`setName(java.lang.String name)` Possibility to specify a name of a instance.
`void`	`update(double value, long time)` add a new point to the time/observation series.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DATA_TimeSeries
```
public static final int DATA_TimeSeries
```
    See Also:
    
    Constant Field Values
  - DATA_Observations
```
public static final int DATA_Observations
```
    See Also:
    
    Constant Field Values
  - INDEX_None
```
public static final int INDEX_None
```
    See Also:
    
    Constant Field Values
  - INDEX_Min_Max
```
public static final int INDEX_Min_Max
```
    See Also:
    
    Constant Field Values
  - INDEX_Mean_StdDev
```
public static final int INDEX_Mean_StdDev
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Statistic
```
public Statistic(Model model,
                 java.lang.String id,
                 int typeData,
                 int typeIndex,
                 boolean aggregate,
                 long timeLow,
                 long timeHigh,
                 double valueLow,
                 double valueHigh,
                 int histogramCells)
```
    Constructor
    
    Parameters:
    
    model - used animation.model.Model
    
    id - must be unique
    
    typeData - one of the following values: Statistic.DATA_Observations Statistic.DATA_TimeSeries
    
    typeIndex - one of the following values: Statistic.INDEX_None Statistic.INDEX_Min_Max Statistic.INDEX_Mean_StdDev
    
    aggregate - true: the values will be aggregated false: the original values will be used
    
    timeLow - lowest expected time, will be changed when a lower time is observed. Used to avoid axis changes.
    
    timeHigh - highest expected time, will be changed when a higher time is observed. Used to avoid axis changes.
    
    valueLow - lowest expected value, will be changed when a lower value is observed. Used to avoid axis changes.
    
    valueHigh - highest expected value, will be changed when a higher value is observed. Used to avoid axis changes.
    
    histogramCells - No. of histogram cells between valueLow and valueHigh. Every cell has the same length. For values outside of [valueLow, valueHigh] additional cells will be created. When <= 0, no histogram data support.
- Method Detail
  - reset
```
public void reset()
```
    reset statistic object, used by warnup called from Model.resetStatistic(...)
  - getModel
```
public Model getModel()
```
    Specified by:
    
    getModel in interface Basic
  - getId
```
public java.lang.String getId()
```
    Specified by:
    
    getId in interface ClassBasic
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface Basic
  - setName
```
public void setName(java.lang.String name)
```
    Possibility to specify a name of a instance. This name is shown in StatisticGrafic
    
    Parameters:
    
    name -
  - update
```
public void update(double value,
                   long time)
            throws ModelException
```
    add a new point to the time/observation series. For time series the times must strictly increasing. For observation series the times must (not strictly)increasing.
    
    Parameters:
    
    value -
    
    time -
    
    Throws:
    
    ModelException - when times are not (strictly) increasing.
  - hasValue
```
public boolean hasValue()
```
    true when one or more points stored.
    
    Returns:
  - getTypeData
```
public int getTypeData()
```
    gets TypeData. Possible values: Statistic.DATA_Observations or Statistic.DATA_TimeSeries
    
    Returns:
  - getTypeIndex
```
public int getTypeIndex()
```
    gets TypeData. Possible values: Statistic.INDEX_None, Statistic.INDEX_Min_Max or Statistic.INDEX_Mean_StdDev
    
    Returns:
  - hasHistogramSupport
```
public boolean hasHistogramSupport()
```
    when no. of histogram cells greater zero
    
    Returns:
  - getValueLow
```
public double getValueLow()
```
    get low value of value axis
    
    Returns:
  - getValueHigh
```
public double getValueHigh()
```
    get high value of value axis
    
    Returns:
  - getTimeLow
```
public long getTimeLow()
```
    get low value of time axis
    
    Returns:
  - getTimeHigh
```
public long getTimeHigh()
```
    get high value of time axis
    
    Returns:
  - getLastValue
```
public double getLastValue()
                    throws ModelException
```
    get last stored value
    
    Returns:
    
    Throws:
    
    ModelException, - when no value stored
    
    ModelException
  - getMin
```
public double getMin()
              throws ModelException
```
    get min value
    
    Returns:
    
    Throws:
    
    ModelException, - when typeIndex != Statistic.INDEX_Min_Max
    
    ModelException
  - getMax
```
public double getMax()
              throws ModelException
```
    get max value
    
    Returns:
    
    Throws:
    
    ModelException, - when typeIndex != Statistic.INDEX_Min_Max
    
    ModelException
  - getMean
```
public double getMean()
               throws ModelException
```
    get mean for typeData = Statistic.DATA_Observations, all values have the same weight. for typeData = Statistic.DATA_TimeSeries, the time depended mean is computed.
    
    Returns:
    
    Throws:
    
    ModelException, - when typeIndex != Statistic.INDEX_Mean_StdDev
    
    ModelException
  - getStdDev
```
public double getStdDev()
                 throws ModelException
```
    get standard deviation for typeData = Statistic.DATA_Observations, all values have the same weight. for typeData = Statistic.DATA_TimeSeries, the time depended standard deviation is computed.
    
    Returns:
    
    Throws:
    
    ModelException, - when typeIndex != Statistic.INDEX_Mean_StdDev
    
    ModelException
  - getFirstTime
```
public long getFirstTime()
                  throws ModelException
```
    get first observation time
    
    Returns:
    
    Throws:
    
    ModelException, - when no observation is stored.
    
    ModelException
  - getLastTime
```
public long getLastTime()
                 throws ModelException
```
    get last observation time
    
    Returns:
    
    Throws:
    
    ModelException, - when no observation is stored.
    
    ModelException
  - getObservationLength
```
public long getObservationLength()
                          throws ModelException
```
    get length of observation time
    
    Returns:
    
    Throws:
    
    ModelException, - when no observation is stored.
    
    ModelException
  - getTimeSerie
```
public TimeSeries getTimeSerie()
                        throws ModelException
```
    get time series in jFreeChart data structure.
    
    Returns:
    
    Throws:
    
    ModelException, - when typeData != Statistic.DATA_TimeSeries
    
    ModelException
  - getObservationSerie
```
public XYSeries getObservationSerie()
                             throws ModelException
```
    get observation series in jFreeChart data structure.
    
    Returns:
    
    Throws:
    
    ModelException, - when typeData != Statistic.DATA_Observations
    
    ModelException
  - getHistogram
```
public XIntervalSeries getHistogram()
                             throws ModelException
```
    get histogram in jFreeChart data structure.
    
    Returns:
    
    Throws:
    
    ModelException, - when histogramCells > 0 (in constructor)
    
    ModelException
  - getHistogramIntervalLength
```
public double getHistogramIntervalLength()
```
    get length of one histogram cell
    
    Returns:
  - getHistogramLow
```
public double getHistogramLow()
```
    get lowest border of lowest histogram cell
    
    Returns:
  - getHistogramHigh
```
public double getHistogramHigh()
```
    get highest border of highest histogram cell
    
    Returns:
  - createGrafic
```
public Grafic createGrafic(java.lang.String viewId,
                           int x,
                           int y,
                           int animationType,
                           boolean isIntValue,
                           java.awt.Dimension deltaSize,
                           boolean infopane)
                    throws ModelException
```
    build an instance of StatisticGrafic
    
    Parameters:
    
    viewId - Id of view
    
    x - x Coordinate of Middle point
    
    y - y Coordinate of Middle point
    
    animationType - Possible values: StatisticGrafic.ANIMATION_LastValue, StatisticGrafic.ANIMATION_TimeValueDiagram StatisticGrafic.ANIMATION_Histogram
    
    isIntValue - In typeAnimation == StatisticGrafic.ANIMATION_LastValue value is shown as integer.
    
    deltaSize - Each animation type has a default size. This size can be incremented/decremented by deltaSize. Null means no change.
    
    Returns:
    
    Throws:
    
    ModelException
  - getGrafic
```
public Grafic getGrafic()
```
    get an existing StatisticGrafic instance.
    
    Specified by:
    
    getGrafic in interface Basic

Class Statistic

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATA_TimeSeries

DATA_Observations

INDEX_None

INDEX_Min_Max

INDEX_Mean_StdDev

Constructor Detail

Statistic

Method Detail

reset

getModel

getId

getName

setName

update

hasValue

getTypeData

getTypeIndex

hasHistogramSupport

getValueLow

getValueHigh

getTimeLow

getTimeHigh

getLastValue

getMin

getMax

getMean

getStdDev

getFirstTime

getLastTime

getObservationLength

getTimeSerie

getObservationSerie

getHistogram

getHistogramIntervalLength

getHistogramLow

getHistogramHigh

createGrafic

getGrafic