com.dukascopy.api.indicators

Class InputParameterInfo

java.lang.Object

com.dukascopy.api.indicators.InputParameterInfo

public class InputParameterInfo
extends Object

Describes indicator input

Author:

Dmitry Shohov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InputParameterInfo.Type Type of the input

Constructor Summary

Constructors

Constructor and Description
InputParameterInfo() Creates input parameter descriptor without setting any field
InputParameterInfo(String name, InputParameterInfo.Type type) Creates input parameter descriptor and sets all the fields

Method Summary

Methods

Modifier and Type	Method and Description
IIndicators.AppliedPrice	getAppliedPrice() Returns default applied price to use
Filter	getFilter() Returns filter of this input or null if no filter was set
Instrument	getInstrument() Returns instrument of this input, or null if no instrument was set
String	getName() Returns name of the input
OfferSide	getOfferSide() Returns side of this input, or null if it was not set
Period	getPeriod() Returns period of this input if it was set, or null if period of the chart should be used
InputParameterInfo.Type	getType() Returns type of the input
boolean	isAllowIndependentPeriod() Returns true if setting of independent periods is allowed for the input
boolean	isAutoAdjustTimeZone() Returns true if input's time zone gets automatically adjusted to chart's time zone.
void	setAllowIndependentPeriod(boolean allowIndependentPeriod) Allows setting periods for this particular input that differ from main input's period.
void	setAppliedPrice(IIndicators.AppliedPrice appliedPrice) Sets default applied price to use
void	setAutoAdjustTimeZone(boolean autoAdjustTimeZone) Enables or disables the automatic adjustment of input period's time zone to chart's time zone (if indicator is on chart).
void	setFilter(Filter filter) Sets filter of this input.
void	setInstrument(Instrument instrument) Sets instrument of this input.
void	setName(String name) Sets name of the input
void	setOfferSide(OfferSide side) Sets side of this input.
void	setPeriod(Period period) Sets period of this input.
void	setType(InputParameterInfo.Type type) Sets type of the input

Methods inherited from class java.lang.Object

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

Constructor Detail

InputParameterInfo

public InputParameterInfo()

Creates input parameter descriptor without setting any field

InputParameterInfo

public InputParameterInfo(String name,
                  InputParameterInfo.Type type)

Creates input parameter descriptor and sets all the fields

Parameters:

name - name of the input

type - type of the input

Method Detail

getName

public String getName()

Returns name of the input

Returns:

name of the input

setName

public void setName(String name)

Sets name of the input

Parameters:

name - of the input

getType

public InputParameterInfo.Type getType()

Returns type of the input

Returns:

type of the input

setType

public void setType(InputParameterInfo.Type type)

Sets type of the input

Parameters:

type - type of the input

getAppliedPrice

public IIndicators.AppliedPrice getAppliedPrice()

Returns default applied price to use

Returns:

default applied price to use

setAppliedPrice

public void setAppliedPrice(IIndicators.AppliedPrice appliedPrice)

Sets default applied price to use

Parameters:

appliedPrice - default applied price to use

getOfferSide

public OfferSide getOfferSide()

Returns side of this input, or null if it was not set

Returns:

side of the input

setOfferSide

public void setOfferSide(OfferSide side)

Sets side of this input. This allows indicator to receive prices of the another side in the same time period

Parameters:

side - side of the input

getPeriod

public Period getPeriod()

Returns period of this input if it was set, or null if period of the chart should be used

Returns:

period of the input

setPeriod

public void setPeriod(Period period)

Sets period of this input. This allows indicator to receive specific period no matter which period is selected on the chart

Parameters:

period - period of the input

getInstrument

public Instrument getInstrument()

Returns instrument of this input, or null if no instrument was set

Returns:

instrument of the input

setInstrument

public void setInstrument(Instrument instrument)

Sets instrument of this input. This allows indicator to receive prices of the another instrument in the same time period

Parameters:

instrument - instrument of the input

getFilter

public Filter getFilter()

Returns filter of this input or null if no filter was set

Returns:

filter of the input

setFilter

public void setFilter(Filter filter)

Sets filter of this input. This allows indicator to get filtered prices for this input even if it's added on chart with another filter

Parameters:

filter - filter of the input

isAllowIndependentPeriod

public boolean isAllowIndependentPeriod()

Returns true if setting of independent periods is allowed for the input

Returns:

true when the setting of independent periods is allowed for the input

setAllowIndependentPeriod

public void setAllowIndependentPeriod(boolean allowIndependentPeriod)

Allows setting periods for this particular input that differ from main input's period. The type of input must be InputParameterInfo.Type.BAR. Indicator is still responsible for handling all synchronization between inputs.

Parameters:

allowIndependentPeriod - allow setting independent periods for this particular input

isAutoAdjustTimeZone

public boolean isAutoAdjustTimeZone()

Returns true if input's time zone gets automatically adjusted to chart's time zone. Set to true by default

Returns:

true if input's time zone is automatically adjusted, false otherwise

setAutoAdjustTimeZone

public void setAutoAdjustTimeZone(boolean autoAdjustTimeZone)

Enables or disables the automatic adjustment of input period's time zone to chart's time zone (if indicator is on chart). When enabled, input period's time zone is ignored and indicator receives data for the same time zone as chart's time zone

Parameters:

autoAdjustTimeZone - enables/disables the automatic adjustment of input period's time zone