|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.dukascopy.api.indicators.IndicatorInfo
public class IndicatorInfo
Describes indicator
Constructor Summary | |
---|---|
IndicatorInfo()
Creates IndicatorInfo without filling any fields |
|
IndicatorInfo(String name,
String title,
String groupName,
boolean overChart,
boolean overVolumes,
boolean unstablePeriod,
boolean candlesticks,
int numberOfInputs,
int numberOfOptionalInputs,
int numberOfOutputs)
Creates IndicatorInfo and fills all fields |
Method Summary | |
---|---|
String |
getGroupName()
Returns name of the group |
String |
getName()
Returns name of the indicator. |
int |
getNumberOfInputs()
Returns number of inputs, that should be provided before calling function |
int |
getNumberOfOptionalInputs()
Returns number of optional inputs, that can be set to customize function |
int |
getNumberOfOutputs()
Returns number of indicator outputs. |
String |
getTitle()
Returns title of the indicator |
boolean |
isCandlesticks()
Returns true if indicator is Pattern Recognition function and should be shown over bars |
boolean |
isOverChart()
Returns true if indicator should be drawn over chart |
boolean |
isOverVolumes()
Returns true if indicator should be shown over volumes |
boolean |
isUnstablePeriod()
Returns true if indicator has unstable period (like EMA or SAR). |
void |
setCandlesticks(boolean candlesticks)
Sets flag that defines indicator as candlestick function |
void |
setGroupName(String groupName)
Sets name of the group |
void |
setName(String name)
Sets name of the indicator. |
void |
setNumberOfInputs(int numberOfInputs)
Sets number of inputs |
void |
setNumberOfOptionalInputs(int numberOfOptionalInputs)
Sets number of optional inputs |
void |
setNumberOfOutputs(int numberOfOutputs)
Sets number of outputs, that indicator will return |
void |
setOverChart(boolean overChart)
Sets flag that defines where indicator should be drawn |
void |
setOverVolumes(boolean overVolumes)
Sets flag that defines where indicator should be drawn |
void |
setTitle(String title)
Sets title of the indicator |
void |
setUnstablePeriod(boolean unstablePeriod)
Sets flag that defines if indicator has unstable period |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IndicatorInfo()
public IndicatorInfo(String name, String title, String groupName, boolean overChart, boolean overVolumes, boolean unstablePeriod, boolean candlesticks, int numberOfInputs, int numberOfOptionalInputs, int numberOfOutputs)
name
- name of the indicator. Should be something simple like SMA for Simple Moving Average or BBANDS for Bollinger Bandstitle
- title of the indicatorgroupName
- name of the indicator groupoverChart
- true if indicator should be drawn over candles/ticksoverVolumes
- true if indicator should be drawn over volume informationunstablePeriod
- true if indicator has unstable period (like EMA or SAR). This will add more candles in every call to stabilize functioncandlesticks
- true if indicator is Pattern Recognition function and should be shown over barsnumberOfInputs
- number of inputs that user should providenumberOfOptionalInputs
- number of optional inputsnumberOfOutputs
- number of outputs, that function returnsMethod Detail |
---|
public String getName()
public void setName(String name)
name
- name of the indicatorpublic String getTitle()
public void setTitle(String title)
title
- title of the indicatorpublic String getGroupName()
public void setGroupName(String groupName)
groupName
- name of the grouppublic boolean isOverChart()
public void setOverChart(boolean overChart)
overChart
- true if indicator should be drawn over chartpublic boolean isOverVolumes()
public void setOverVolumes(boolean overVolumes)
overVolumes
- true if indicator should be shown over volumespublic boolean isUnstablePeriod()
public void setUnstablePeriod(boolean unstablePeriod)
unstablePeriod
- true if indicator has unstable periodpublic boolean isCandlesticks()
public void setCandlesticks(boolean candlesticks)
candlesticks
- true if indicator is Pattern Recognition function and should be shown over barspublic int getNumberOfInputs()
public void setNumberOfInputs(int numberOfInputs)
numberOfInputs
- number of inputspublic int getNumberOfOptionalInputs()
public void setNumberOfOptionalInputs(int numberOfOptionalInputs)
numberOfOptionalInputs
- number of optional inputspublic int getNumberOfOutputs()
public void setNumberOfOutputs(int numberOfOutputs)
numberOfOutputs
- number of outputs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |