com.steema.teechart.functions
Class Cumulative

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.functions.Function
          extended by com.steema.teechart.functions.Cumulative

public class Cumulative
extends Function

Title: Cumulative class

Description: The Cumulative function sums the Series values starting from the first point.

Example: Given these values: 1 2 3 The Cumulative function returns: 1 3 6 ( 1=1, 1+2=3 and 1+2+3=6 )

Example:


 cumulativeFunction = new com.steema.teechart.functions.
       Cumulative(myChart.getChart());
 cumulativeFunction.setPeriod(1);

 lineSeries.setDataSource(barSeries);
 lineSeries.setFunction(cumulativeFunction);
 

Copyright (c) 2005-2013 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL


Field Summary
 
Fields inherited from class com.steema.teechart.functions.Function
canUsePeriod, dPeriod, HideSourceList, noSourceRequired, series, SingleSource, updating
 
Fields inherited from class com.steema.teechart.TeeBase
chart, InternalUse
 
Constructor Summary
Cumulative()
           
Cumulative(IBaseChart c)
           
 
Method Summary
 double calculate(Series sourceSeries, int firstIndex, int lastIndex)
          Performs function operation on SourceSeries series.
 double calculateMany(java.util.Vector sourceSeriesList, int valueIndex)
          Performs function operation on list of series (SourceSeriesList).
 java.lang.String getDescription()
          Gets descriptive text.
 
Methods inherited from class com.steema.teechart.functions.Function
addFunctionXY, addPoints, calculateAllPoints, calculateByPeriod, calculatePeriod, clear, dispose, doCalculation, getPeriod, getPeriodAlign, getPeriodStyle, getSeries, newInstance, readResolve, recalculate, setPeriod, setPeriodAlign, setPeriodStyle, setSeries, valueList
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, invalidate, setBooleanProperty, setChart, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Cumulative

public Cumulative()

Cumulative

public Cumulative(IBaseChart c)
Method Detail

calculate

public double calculate(Series sourceSeries,
                        int firstIndex,
                        int lastIndex)
Performs function operation on SourceSeries series.
First and Last parameters are ValueIndex of first and last point used in calculation. You can override Calculate function to perform customized calculation on one SourceSeries.

Overrides:
calculate in class Function
Parameters:
sourceSeries - Series
firstIndex - int
lastIndex - int
Returns:
double

calculateMany

public double calculateMany(java.util.Vector sourceSeriesList,
                            int valueIndex)
Performs function operation on list of series (SourceSeriesList).
The ValueIndex parameter defines ValueIndex of point in each Series in list. You can override CalculateMany function to perform customized calculation on list of SourceSeries.

Overrides:
calculateMany in class Function
Parameters:
sourceSeriesList - ArrayList
valueIndex - int
Returns:
double

getDescription

public java.lang.String getDescription()
Gets descriptive text.

Overrides:
getDescription in class Function
Returns:
String