com.dukascopy.api.system
Enum ITesterClient.DataLoadingMethod

java.lang.Object
  extended by java.lang.Enum<ITesterClient.DataLoadingMethod>
      extended by com.dukascopy.api.system.ITesterClient.DataLoadingMethod
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ITesterClient.DataLoadingMethod>
Enclosing interface:
ITesterClient

public static enum ITesterClient.DataLoadingMethod
extends java.lang.Enum<ITesterClient.DataLoadingMethod>

Different ticks loading methods Depending on selected method different amount of ticks will be passed to the IStrategy.onTick() method


Enum Constant Summary
ALL_TICKS
          All ticks will be loaded
DIFFERENT_PRICE_TICKS
          The current Tick will be skipped in case if it has the same ask and bid prices as previous Tick
PIVOT_TICKS
          Pivot or extremum Ticks will be loaded
TICKS_WITH_PRICE_DIFFERENCE_IN_PIPS
          Ticks with price difference greater or equal to the specified number of pips will be loaded
TICKS_WITH_TIME_INTERVAL
          Ticks with time difference greater or equal to the specified time interval will be loaded
 
Method Summary
 int getPriceDifferenceInPips()
          Returns price difference in pips
 long getTimeIntervalBetweenTicks()
          Returns time interval in milliseconds.
 void setPriceDifferenceInPips(int priceDifferenceInPips)
          Sets the price difference in pips.
 void setTimeIntervalBetweenTicks(long timeIntervalBetweenTicks)
          Sets the time interval in milliseconds.
static ITesterClient.DataLoadingMethod valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ITesterClient.DataLoadingMethod[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ALL_TICKS

public static final ITesterClient.DataLoadingMethod ALL_TICKS
All ticks will be loaded


DIFFERENT_PRICE_TICKS

public static final ITesterClient.DataLoadingMethod DIFFERENT_PRICE_TICKS
The current Tick will be skipped in case if it has the same ask and bid prices as previous Tick


PIVOT_TICKS

public static final ITesterClient.DataLoadingMethod PIVOT_TICKS
Pivot or extremum Ticks will be loaded


TICKS_WITH_PRICE_DIFFERENCE_IN_PIPS

public static final ITesterClient.DataLoadingMethod TICKS_WITH_PRICE_DIFFERENCE_IN_PIPS
Ticks with price difference greater or equal to the specified number of pips will be loaded

See Also:
setPriceDifferenceInPips(int priceDifferenceInPips)

TICKS_WITH_TIME_INTERVAL

public static final ITesterClient.DataLoadingMethod TICKS_WITH_TIME_INTERVAL
Ticks with time difference greater or equal to the specified time interval will be loaded

See Also:
setTimeIntervalBetweenTicks(long timeIntervalBetweenTicks)
Method Detail

values

public static ITesterClient.DataLoadingMethod[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ITesterClient.DataLoadingMethod c : ITesterClient.DataLoadingMethod.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ITesterClient.DataLoadingMethod valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

setPriceDifferenceInPips

public void setPriceDifferenceInPips(int priceDifferenceInPips)
Sets the price difference in pips.

Parameters:
priceDifferenceInPips - price difference in pips
See Also:
TICKS_WITH_PRICE_DIFFERENCE_IN_PIPS

getPriceDifferenceInPips

public int getPriceDifferenceInPips()
Returns price difference in pips

Returns:
price difference in pips
See Also:
TICKS_WITH_PRICE_DIFFERENCE_IN_PIPS

setTimeIntervalBetweenTicks

public void setTimeIntervalBetweenTicks(long timeIntervalBetweenTicks)
Sets the time interval in milliseconds.

Parameters:
timeIntervalBetweenTicks - time interval in milliseconds
See Also:
TICKS_WITH_TIME_INTERVAL

getTimeIntervalBetweenTicks

public long getTimeIntervalBetweenTicks()
Returns time interval in milliseconds.

Returns:
time interval in milliseconds
See Also:
TICKS_WITH_TIME_INTERVAL