com.steema.teechart.functions
Class Custom

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

All Implemented Interfaces:

java.io.Serializable

public class Custom
extends Function

Title: Custom class

Description: Custom y=f(x) function

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

Company: Steema Software SL

See Also:

Serialized Form

Nested Class Summary

static interface

Custom.YCalculator

Field Summary

double

x

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

Custom()

Custom(IBaseChart c)

Method Summary

void	addPoints(java.util.ArrayList source) Gets all points from Source series, performs a function operation and stores results in ParentSeries.
java.lang.String	getDescription() Gets descriptive text.
int	getNumPoints() The number of points.
double	getStartX() The initial value for the "X" parameter.
Custom.YCalculator	getYCalculator()
void	setNumPoints(int value) Sets the number of points.
void	setStartX(double value) Sets the initial value for the "X" parameter.
void	setYCalculator(Custom.YCalculator value)

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

addFunctionXY, calculate, calculateAllPoints, calculateByPeriod, calculateMany, calculatePeriod, 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

Field Detail

x

public double x

Constructor Detail

Custom

public Custom()

Custom

public Custom(IBaseChart c)

Method Detail

getNumPoints

public int getNumPoints()

The number of points.
The function will call its OnCalculate event this number of times.
Default value: 100

Returns:

int

setNumPoints

public void setNumPoints(int value)

Sets the number of points.
The function will call its OnCalculate event this number of times.
Default value: 100

Parameters:

value - int

getYCalculator

public Custom.YCalculator getYCalculator()

setYCalculator

public void setYCalculator(Custom.YCalculator value)

getStartX

public double getStartX()

The initial value for the "X" parameter.
The function will call its OnCalculate event this number of times.
Default value: O

Returns:

double

setStartX

public void setStartX(double value)

Sets the initial value for the "X" parameter.
The function will call its OnCalculate event this number of times.
Default value: O

Parameters:

value - double

addPoints

public void addPoints(java.util.ArrayList source)

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