com.steema.teechart.functions
Class Smoothing

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

public class Smoothing
extends Function

Title: Smoothing class

Description: Smoothing Function.

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
Smoothing()
           
Smoothing(IBaseChart c)
           
 
Method Summary
 void addPoints(java.util.Vector source)
          gets all points from Source series, performs a function operation on points and finally stores results in ParentSeries.
 java.lang.String getDescription()
          Gets descriptive text.
 int getFactor()
          The number of times the resulting smooth points are compared to source points.
 boolean getInterpolate()
          When true, resulting smooth curves will pass exactly over source points.
 void setFactor(int value)
          Sets the number of times the resulting smooth points are compared to source points.
 void setInterpolate(boolean value)
          Resulting smooth curves will pass exactly over source points when true.
 
Methods inherited from class com.steema.teechart.functions.Function
addFunctionXY, calculate, calculateAllPoints, calculateByPeriod, calculateMany, 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

Smoothing

public Smoothing()

Smoothing

public Smoothing(IBaseChart c)
Method Detail

getInterpolate

public boolean getInterpolate()
When true, resulting smooth curves will pass exactly over source points.
When false, the smooth curves will not necessarily pass over source points.
Default value: true

Returns:
boolean

setInterpolate

public void setInterpolate(boolean value)
Resulting smooth curves will pass exactly over source points when true.
When false, the smooth curves will not necessarily pass over source points.
Default value: true

Parameters:
value - boolean

getFactor

public int getFactor()
The number of times the resulting smooth points are compared to source points.
For example, a value of 4 means the smooth points will be 4 times the number of source points.
The greater the factor value is, the smoother the resulting curves will be.
Default value: 4

Returns:
int

setFactor

public void setFactor(int value)
Sets the number of times the resulting smooth points are compared to source points.
Default value: 4

Parameters:
value - int

addPoints

public void addPoints(java.util.Vector source)
gets all points from Source series, performs a function operation on points and finally stores results in ParentSeries.

Overrides:
addPoints in class Function
Parameters:
source - ArrayList

getDescription

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

Overrides:
getDescription in class Function
Returns:
String