com.steema.teechart.functions
Class SAR

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.functions.Function
          com.steema.teechart.functions.SAR

All Implemented Interfaces:

java.io.Serializable

public class SAR
extends Function

Title: SAR class

Description: SAR Function.

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

Company: Steema Software SL

See Also:

Serialized Form

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

Constructor Summary

SAR()

SAR(IBaseChart c)

Method Summary

void	addPoints(java.util.ArrayList source) Gets all points from Source series, performs a function operation on points and stores results in ParentSeries.
double	getAF() SAR acceleration factor.
java.lang.String	getDescription() Gets descriptive text.
double	getMS() SAR maximum step.
boolean	isValidSourceOf(ISeries value)
void	SetAF(double value) Sets SAR function acceleration factor.
void	SetMS(double value) Sets SAR function maximal step.

Methods inherited from class com.steema.teechart.functions.Function

addFunctionXY, calculate, calculateAllPoints, calculateByPeriod, calculateMany, calculatePeriod, clear, 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, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

SAR

public SAR()

SAR

public SAR(IBaseChart c)

Method Detail

SetMS

public void SetMS(double value)

Sets SAR function maximal step.

Parameters:

value - maximal step value.

getMS

public double getMS()

SAR maximum step.

Returns:

max step.

SetAF

public void SetAF(double value)

Sets SAR function acceleration factor.

Parameters:

value - Acceleration factor value.

getAF

public double getAF()

SAR acceleration factor.

Returns:

acceleration factor.

addPoints

public void addPoints(java.util.ArrayList source)

Gets all points from Source series, performs a function operation on points and 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

isValidSourceOf

public boolean isValidSourceOf(ISeries value)