com.motivewave.platform.sdk.common

Class Settings

java.lang.Object

com.motivewave.platform.sdk.common.Settings

All Implemented Interfaces:

java.lang.Cloneable

public class Settings
extends java.lang.Object
implements java.lang.Cloneable

Encapsulates the configuration information for a study or strategy.

Constructor Summary

Constructors

Constructor and Description
Settings()

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a property change listener.
void	addSession(TimeFrame session) Adds a session to the strategy.
Settings	clone() Creates a clone (copy) of this object.
boolean	equals(java.lang.Object o) Compares this settings object with the given object and returns true if they are equal.
java.util.Set<java.lang.String>	getBars() Gets the set of all registered bar names.
BarInfo	getBars(java.lang.String name) Gets the bar info associated to the given name.
BarSize	getBarSize(java.lang.String name) Gets the bar size associated to the given name.
java.util.Set<java.lang.String>	getBarSizes() Gets the set of all registered bar size names.
java.lang.Boolean	getBoolean(java.lang.String name) Gets the boolean value associated to the given name.
boolean	getBoolean(java.lang.String name, boolean def) Gets the boolean value associated to the given name.
java.awt.Color	getColor(java.lang.String name) Gets the color associated to the given name.
java.awt.Color	getColor(java.lang.String name, java.awt.Color def) Gets the color associated to the given name.
ColorInfo	getColorInfo(java.lang.String name) Gets the color info object associated to the given name
java.util.Set<java.lang.String>	getColors() Gets the set of all registered color names.
SettingsDescriptor	getDescriptor() Gets the SettingsDescriptor object that describes the user settings.
java.lang.Double	getDouble(java.lang.String name) Gets the double value associated to the given name.
double	getDouble(java.lang.String name, double def) Gets the double value associated to the given name.
ExitPoint	getExitPoint(java.lang.String name) Gets the exit point associated to the given name.
java.util.Set<java.lang.String>	getExitPoints() Gets the set of all registered Exit Point names.
FontInfo	getFont(java.lang.String name) Gets the font associated with the given name.
java.util.Set<java.lang.String>	getFonts() Gets the set of all registered font names.
GuideInfo	getGuide(java.lang.String name) Gets the GuideInfo associated to the given name
java.util.Set<java.lang.String>	getGuides() Gets the set of all registered guide names.
IndicatorInfo	getIndicator(java.lang.String name) Gets the indicator associated with the given name
java.util.Set<java.lang.String>	getIndicators() Get the set of all registered indicator names.
java.lang.Object	getInput(java.lang.String name) Gets the input associated to the given name.
java.lang.Object	getInput(java.lang.String name, java.lang.Object def) Gets the input key associated to the given name.
java.util.Set<java.lang.String>	getInputs() Gets the set of all registered input names.
Instrument	getInstrument(java.lang.String name) Gets the instrument associated to the given name
java.util.Set<java.lang.String>	getInstruments() Gets the set of all registered instrument names.
java.lang.Integer	getInteger(java.lang.String name) Gets the integer value associated to the given name.
int	getInteger(java.lang.String name, int def) Gets the integer value associated to the given name.
java.lang.Long	getLong(java.lang.String name) Gets the long value associated to the given name.
Enums.MAMethod	getMAMethod(java.lang.String name) Gets the Moving Average Calculation method associated to the given name
Enums.MAMethod	getMAMethod(java.lang.String name, Enums.MAMethod def) Gets the Moving Average Calculation method associated to the given name.
java.util.Set<java.lang.String>	getMAMethods() Gets the set of all registered Moving Average Method names.
MarkerInfo	getMarker(java.lang.String name) Gets the MarkerInfo object associated with the given name
java.util.Set<java.lang.String>	getMarkers() Gets the set of registered marker names.
Enums.OrderType	getOrderType(java.lang.String name) Gets the order type associated to the given name.
PathInfo	getPath(java.lang.String name) Gets the PathInfo object associated with the given name
java.util.Set<java.lang.String>	getPaths() Gets the set of all registered path names
Enums.PositionType	getPositionType() Indicates position type to be used with the strategy (long, short or both).
java.util.List<TimeFrame>	getSessions() Gets the trading sessions (strategies only).
java.lang.Object	getSetting(java.lang.String name) Gets the setting associated to the given name.
ShadeInfo	getShade(java.lang.String name) Gets the ShadeInfo object associated to the given name.
java.util.Set<java.lang.String>	getShades() Gets the set of all registered shade names.
java.lang.String	getString(java.lang.String name) Gets the string value associated to the given name.
java.lang.String	getString(java.lang.String name, java.lang.String def) Gets the string value associated to the given name.
Enums.TIF	getTIF(java.lang.String name) Gets the tif (Time In Force) value associated to the given name.
TimeFrame	getTimeFrame(java.lang.String name) Gets the timeframe associated to the given name.
java.util.Set<java.lang.String>	getTimeFrames() Gets the set of all registered time frame names.
Enums.TIF	getTimeInForce() Gets the time in force (TIF) for orders (strategies only).
java.util.TimeZone	getTimeZone() Gets the timezone for sessions (null for local time zone).
int	getTradeLots() Gets the number of trade lots to use (strategies only).
java.lang.Object	getValue(java.lang.String name) Gets the set of value associated with the given key.
java.util.Set<java.lang.String>	getValues() Gets the set of value keys in the settings.
boolean	isAutoEntry() Indicates if the strategy has auto entry enabled.
boolean	isBarUpdates() Indicates if this study should respond to bar updates instead of only calculating on the close of the bar.
boolean	isCloseOnDeactivate() Indicates if a position should be closed when the strategy is deactivated.
boolean	isCloseOnSessionEnd() Determines if this strategy should exit an open position automatically when a trading session closes.
boolean	isEnterOnActivate() Indicates if a position should be opened when the strategy is activated.
boolean	isEnterOnSessionStart() Determines if this strategy should enter automatically when a trading session opens.
boolean	isUseAccountPosition() Indicates if this study should use the existing position that is available on the account.
void	removeAllPropertyChangeListeners() Removes all property change listeners.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a property change listener.
void	setAutoEntry(boolean b) Sets the auto entry attribute for the strategy.
void	setBars(java.lang.String name, BarInfo bar) Associates the given BarInfo to the specified name.
void	setBarSize(java.lang.String name, BarSize barSize) Associates the given BarSize to the specified name.
void	setBarUpdates(boolean b) Indicates if this study should respond to bar updates instead of only calculating on the close of the bar.
void	setBoolean(java.lang.String name, java.lang.Boolean val) Associates the given boolean value to the specified name.
void	setCloseOnDeactivate(boolean b) Indicates if a position should be closed when the strategy is deactivated.
void	setCloseOnSessionEnd(boolean b) Sets the close position on session end attribute (this is called by the study framework).
void	setColor(java.lang.String name, java.awt.Color color) Associates the given Color to the specified name.
void	setColor(java.lang.String name, ColorInfo color) Associates the given Color to the specified name.
void	setDescriptor(SettingsDescriptor desc) Sets the SettingsDescriptor object.
void	setDouble(java.lang.String name, java.lang.Double val) Associates the given double value to the specified name.
void	setEnterOnActivate(boolean b) Indicates if a position should be opened when the strategy is activated.
void	setEnterOnSessionStart(boolean b) Sets the enter on session start attribute (this is called by the study framework).
void	setExitPoint(java.lang.String name, ExitPoint ep) Associates the given ExitPoint to the specified name.
void	setFont(java.lang.String name, FontInfo font) Associates the given FontInfo to the specified name.
void	setGuide(java.lang.String name, GuideInfo guide) Associates the given GuideInfo to the specified name.
void	setIndicator(java.lang.String name, IndicatorInfo indicator) Associates the given IndicatorInfo to the specified name.
void	setInput(java.lang.String name, java.lang.Object input) Associates the given input key to the specified name.
void	setInstrument(java.lang.String name, Instrument instrument) Associates the given Instrument to the specified name.
void	setInteger(java.lang.String name, java.lang.Integer val) Associates the given integer value to the specified name.
void	setLong(java.lang.String name, java.lang.Long val) Associates the given integer value to the specified name.
void	setMAMethod(java.lang.String name, Enums.MAMethod method) Associates the given MAMethod to the specified name.
void	setMarker(java.lang.String name, MarkerInfo marker) Associates the given MarkerInfo to the specified name.
void	setOrderType(java.lang.String name, Enums.OrderType type) Associates the given OrderType to the specified name.
void	setPath(java.lang.String name, PathInfo path) Associates the given PathInfo to the specified name.
void	setPositionType(Enums.PositionType p) Sets the position type for the strategy.
void	setShade(java.lang.String name, ShadeInfo shade) Associates the given ShadeInfo to the specified name.
void	setString(java.lang.String name, java.lang.String val) Associates the given string value to the specified name.
void	setTIF(java.lang.String name, Enums.TIF tif) Associates the given TIF (time in force) to the specified name.
void	setTimeFrame(java.lang.String name, TimeFrame tf) Associates the given TimeFrame to the specified name.
void	setTimeInForce(Enums.TIF tif) Sets the time in force (TIF) for orders (strategies only).
void	setTimeZone(java.util.TimeZone tz) Sets the timezone for sessions (null for local time zone).
void	setTradeLots(int tradeLots) Sets the number of trade lots to use (strategies only).
void	setUseAccountPosition(boolean b) Indicates if this study should use the existing position that is available on the account.
void	update(Settings settings) Updates the information from the given object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Settings

public Settings()

Method Detail

setDescriptor

public void setDescriptor(SettingsDescriptor desc)

Sets the SettingsDescriptor object. This is called by the underlying study framework.

Parameters:

desc - settings descriptor object

getDescriptor

public SettingsDescriptor getDescriptor()

Gets the SettingsDescriptor object that describes the user settings.

getPath

public PathInfo getPath(java.lang.String name)

Gets the PathInfo object associated with the given name

Parameters:

name - name

Returns:

the PathInfo associated to the given name.

setPath

public void setPath(java.lang.String name,
           PathInfo path)

Associates the given PathInfo to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the path (key)

path - path info object

getPaths

public java.util.Set<java.lang.String> getPaths()

Gets the set of all registered path names

Returns:

a set of all the registered path names.

getMarker

public MarkerInfo getMarker(java.lang.String name)

Gets the MarkerInfo object associated with the given name

Parameters:

name -

Returns:

the MarkerInfo associated to the given name.

setMarker

public void setMarker(java.lang.String name,
             MarkerInfo marker)

Associates the given MarkerInfo to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the marker

marker - marker info

getMarkers

public java.util.Set<java.lang.String> getMarkers()

Gets the set of registered marker names.

Returns:

a set of all the registered markers.

getIndicator

public IndicatorInfo getIndicator(java.lang.String name)

Gets the indicator associated with the given name

Parameters:

name - name of the indicator

Returns:

the IndicatorInfo associated to the given name.

setIndicator

public void setIndicator(java.lang.String name,
                IndicatorInfo indicator)

Associates the given IndicatorInfo to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the indicator

indicator - indicator info object

getIndicators

public java.util.Set<java.lang.String> getIndicators()

Get the set of all registered indicator names.

Returns:

a set of all the registered indicator names.

getBars

public BarInfo getBars(java.lang.String name)

Gets the bar info associated to the given name.

Parameters:

name - name of the bar info

Returns:

the BarInfo associated to the given name.

setBars

public void setBars(java.lang.String name,
           BarInfo bar)

Associates the given BarInfo to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the bar info

bar - bar info object

getBars

public java.util.Set<java.lang.String> getBars()

Gets the set of all registered bar names.

Returns:

a set of all the registered bar names.

getShade

public ShadeInfo getShade(java.lang.String name)

Gets the ShadeInfo object associated to the given name.

Parameters:

name - name of the shade

Returns:

the ShadeInfo associated to the given name.

setShade

public void setShade(java.lang.String name,
            ShadeInfo shade)

Associates the given ShadeInfo to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the shade

shade - shade info object

getShades

public java.util.Set<java.lang.String> getShades()

Gets the set of all registered shade names.

Returns:

a set of all the registered shade names.

getGuide

public GuideInfo getGuide(java.lang.String name)

Gets the GuideInfo associated to the given name

Parameters:

name - name of the guide

Returns:

the GuideInfo associated to the given name.

setGuide

public void setGuide(java.lang.String name,
            GuideInfo guide)

Associates the given GuideInfo to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the guide

guide - guide info object

getGuides

public java.util.Set<java.lang.String> getGuides()

Gets the set of all registered guide names.

Returns:

a set of all the registered guides.

getFont

public FontInfo getFont(java.lang.String name)

Gets the font associated with the given name.

Parameters:

name - name of the font

Returns:

the FontInfo associated to the given name.

setFont

public void setFont(java.lang.String name,
           FontInfo font)

Associates the given FontInfo to the specified name. This is called by the underlying study framework.

Parameters:

name - font name

font - font info object

getFonts

public java.util.Set<java.lang.String> getFonts()

Gets the set of all registered font names.

Returns:

a set of all the registered font names.

getColor

public java.awt.Color getColor(java.lang.String name)

Gets the color associated to the given name.

Parameters:

name - name of the color

Returns:

the Color associated to the given name.

getColorInfo

public ColorInfo getColorInfo(java.lang.String name)

Gets the color info object associated to the given name

Parameters:

name - name of the color

Returns:

the Color associated to the given name.

getColor

public java.awt.Color getColor(java.lang.String name,
                      java.awt.Color def)

Gets the color associated to the given name. The default color is returned if the color is undefined (null).

Parameters:

name - name of the color

def - default value if the color is not defined

Returns:

the Color associated to the given name. If the color is null, the default color 'def' is returned.

setColor

public void setColor(java.lang.String name,
            java.awt.Color color)

Associates the given Color to the specified name.

Parameters:

name - name of the color

color - color

setColor

public void setColor(java.lang.String name,
            ColorInfo color)

Associates the given Color to the specified name.

Parameters:

name - name of the color

color - color info object

getColors

public java.util.Set<java.lang.String> getColors()

Gets the set of all registered color names.

Returns:

a set of all the registered color names.

getInput

public java.lang.Object getInput(java.lang.String name)

Gets the input associated to the given name.

Parameters:

name - name of the input key

Returns:

the input key associated to the given name.

getInput

public java.lang.Object getInput(java.lang.String name,
                        java.lang.Object def)

Gets the input key associated to the given name. The 'def' value is returned if there is no input associated with the given name.

Parameters:

name - name of the input

def - default to return if the input is undefined

Returns:

the input key associated to the given name.

setInput

public void setInput(java.lang.String name,
            java.lang.Object input)

Associates the given input key to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the input

input - input key

getInputs

public java.util.Set<java.lang.String> getInputs()

Gets the set of all registered input names.

Returns:

a set of all the registered input names.

getMAMethod

public Enums.MAMethod getMAMethod(java.lang.String name)

Gets the Moving Average Calculation method associated to the given name

Parameters:

name - name of the method

Returns:

the MAMethod associated to the given name.

getMAMethod

public Enums.MAMethod getMAMethod(java.lang.String name,
                         Enums.MAMethod def)

Gets the Moving Average Calculation method associated to the given name. The given default value is returned if the method is not defined.

Parameters:

name - name of the method

def - default value to return if the method is not defined

Returns:

the MAMethod associated to the given name.

setMAMethod

public void setMAMethod(java.lang.String name,
               Enums.MAMethod method)

Associates the given MAMethod to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the method

method - moving average method

getMAMethods

public java.util.Set<java.lang.String> getMAMethods()

Gets the set of all registered Moving Average Method names.

Returns:

a set of all the registered MAMethod names.

getBarSize

public BarSize getBarSize(java.lang.String name)

Gets the bar size associated to the given name.

Parameters:

name - name of the bar size

Returns:

the BarSize associated to the given name.

setBarSize

public void setBarSize(java.lang.String name,
              BarSize barSize)

Associates the given BarSize to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the bar size

barSize - bar size

getBarSizes

public java.util.Set<java.lang.String> getBarSizes()

Gets the set of all registered bar size names.

Returns:

a set of all the registered BarSize names.

getInstrument

public Instrument getInstrument(java.lang.String name)

Gets the instrument associated to the given name

Parameters:

name - name of the instrument

Returns:

the Instrument associated to the given name.

setInstrument

public void setInstrument(java.lang.String name,
                 Instrument instrument)

Associates the given Instrument to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the instrument

instrument - instrument to associate

getInstruments

public java.util.Set<java.lang.String> getInstruments()

Gets the set of all registered instrument names.

Returns:

a set of all the registered Instrument names.

getExitPoint

public ExitPoint getExitPoint(java.lang.String name)

Gets the exit point associated to the given name.

Parameters:

name - name of the exit point

Returns:

the ExitPoint associated to the given name.

setExitPoint

public void setExitPoint(java.lang.String name,
                ExitPoint ep)

Associates the given ExitPoint to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the exit point

ep - exit point

getExitPoints

public java.util.Set<java.lang.String> getExitPoints()

Gets the set of all registered Exit Point names.

Returns:

a set of all the registered ExitPoint names.

getTimeFrame

public TimeFrame getTimeFrame(java.lang.String name)

Gets the timeframe associated to the given name.

Parameters:

name - name of the timeframe

Returns:

the TimeFrame associated to the given name.

setTimeFrame

public void setTimeFrame(java.lang.String name,
                TimeFrame tf)

Associates the given TimeFrame to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the timeframe

tf - time frame to associate to the given name

getTimeFrames

public java.util.Set<java.lang.String> getTimeFrames()

Gets the set of all registered time frame names.

Returns:

a set of all the registered TimeFrame names.

getOrderType

public Enums.OrderType getOrderType(java.lang.String name)

Gets the order type associated to the given name.

Parameters:

name - name of the order type

Returns:

the OrderType associated to the given name.

setOrderType

public void setOrderType(java.lang.String name,
                Enums.OrderType type)

Associates the given OrderType to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the order type

type - order type

getTIF

public Enums.TIF getTIF(java.lang.String name)

Gets the tif (Time In Force) value associated to the given name.

Parameters:

name - name of the tif

Returns:

time in force associated to the given name

setTIF

public void setTIF(java.lang.String name,
          Enums.TIF tif)

Associates the given TIF (time in force) to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the tif

tif - time in force

getValues

public java.util.Set<java.lang.String> getValues()

Gets the set of value keys in the settings.

Returns:

set of value keys in the settings

getValue

public java.lang.Object getValue(java.lang.String name)

Gets the set of value associated with the given key.

Parameters:

name - name of the value

Returns:

value associated to the given name

getDouble

public java.lang.Double getDouble(java.lang.String name)

Gets the double value associated to the given name.

Parameters:

name - name of the double value

Returns:

double value associated to the given name

getDouble

public double getDouble(java.lang.String name,
               double def)

Gets the double value associated to the given name. The def value is returned if the setting does not exist.

Parameters:

name - name of the double value

def - default value to return if not defined

Returns:

double value associated to the given name.

setDouble

public void setDouble(java.lang.String name,
             java.lang.Double val)

Associates the given double value to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the double value

val - double value

getInteger

public java.lang.Integer getInteger(java.lang.String name)

Gets the integer value associated to the given name.

Parameters:

name - name of the value

Returns:

integer value associated to the given name

getInteger

public int getInteger(java.lang.String name,
             int def)

Gets the integer value associated to the given name. The def value is returned if the setting does not exist.

Parameters:

name - name of the integer value

def - default value to return if the name does not exist

Returns:

integer value

setInteger

public void setInteger(java.lang.String name,
              java.lang.Integer val)

Associates the given integer value to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the value

val - value to associate

getLong

public java.lang.Long getLong(java.lang.String name)

Gets the long value associated to the given name.

Parameters:

name - name of the value

Returns:

long value associated to the given name

setLong

public void setLong(java.lang.String name,
           java.lang.Long val)

Associates the given integer value to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the value

val - value to associate

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name)

Gets the boolean value associated to the given name.

Parameters:

name - name of the value

Returns:

associated boolean value

getBoolean

public boolean getBoolean(java.lang.String name,
                 boolean def)

Gets the boolean value associated to the given name. The def value is returned if the setting does not exist.

Parameters:

name - name of the boolean value

def - default value to return if the name does not exist

Returns:

boolean value

setBoolean

public void setBoolean(java.lang.String name,
              java.lang.Boolean val)

Associates the given boolean value to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the value

val - value to associate

getString

public java.lang.String getString(java.lang.String name)

Gets the string value associated to the given name.

Parameters:

name - name of the value

Returns:

String value associated to the given name

getString

public java.lang.String getString(java.lang.String name,
                         java.lang.String def)

Gets the string value associated to the given name. The 'def' value is returned if the value is not defined

Parameters:

name - name of the string value

def - default value to return if the string does not exist

Returns:

string value

setString

public void setString(java.lang.String name,
             java.lang.String val)

Associates the given string value to the specified name. This is called by the underlying study framework.

Parameters:

name - name of the value

val - string value to associate

getSetting

public java.lang.Object getSetting(java.lang.String name)

Gets the setting associated to the given name.

Parameters:

name - name of the setting

Returns:

the setting associated with the specified name.

update

public void update(Settings settings)

Updates the information from the given object. This is called by the underlying study framework.

Parameters:

settings - settings object

isBarUpdates

public boolean isBarUpdates()

Indicates if this study should respond to bar updates instead of only calculating on the close of the bar.

Returns:

true if bar updates is enabled.

setBarUpdates

public void setBarUpdates(boolean b)

Indicates if this study should respond to bar updates instead of only calculating on the close of the bar.

Parameters:

b - true if bar updates is enabled.

isUseAccountPosition

public boolean isUseAccountPosition()

Indicates if this study should use the existing position that is available on the account.

Returns:

true if the account position should be used.

setUseAccountPosition

public void setUseAccountPosition(boolean b)

Indicates if this study should use the existing position that is available on the account.

Parameters:

b - true if the account position should be used.

isAutoEntry

public boolean isAutoEntry()

Indicates if the strategy has auto entry enabled.

Returns:

true if auto entry is enabled

setAutoEntry

public void setAutoEntry(boolean b)

Sets the auto entry attribute for the strategy.

Parameters:

b - true if auto entry is enabled

getPositionType

public Enums.PositionType getPositionType()

Indicates position type to be used with the strategy (long, short or both).

Returns:

position type

setPositionType

public void setPositionType(Enums.PositionType p)

Sets the position type for the strategy.

Parameters:

p - position type

isEnterOnActivate

public boolean isEnterOnActivate()

Indicates if a position should be opened when the strategy is activated. This feature is only set if the strategy supports 'enter on activate' (see StudyHeader).

Returns:

true if enter on activate is enabled

setEnterOnActivate

public void setEnterOnActivate(boolean b)

Indicates if a position should be opened when the strategy is activated. This feature is only set if the strategy supports 'enter on activate' (see StudyHeader).

Parameters:

b - true if enter on activate is enabled

isCloseOnDeactivate

public boolean isCloseOnDeactivate()

Indicates if a position should be closed when the strategy is deactivated. This feature is only set if the strategy supports 'close on deactivate' (see StudyHeader).

Returns:

true if close on deactivate is enabled

setCloseOnDeactivate

public void setCloseOnDeactivate(boolean b)

Indicates if a position should be closed when the strategy is deactivated. This feature is only set if the strategy supports 'close on deactivate' (see StudyHeader).

Parameters:

b - true if close on deactivate is enabled

setTimeInForce

public void setTimeInForce(Enums.TIF tif)

Sets the time in force (TIF) for orders (strategies only).

Parameters:

tif - time in force

getTimeInForce

public Enums.TIF getTimeInForce()

Gets the time in force (TIF) for orders (strategies only).

Returns:

time in force

setTradeLots

public void setTradeLots(int tradeLots)

Sets the number of trade lots to use (strategies only).

Parameters:

tradeLots - number of trade lots

getTradeLots

public int getTradeLots()

Gets the number of trade lots to use (strategies only).

Returns:

number of trade lots

getSessions

public java.util.List<TimeFrame> getSessions()

Gets the trading sessions (strategies only).

Returns:

trading sessions

addSession

public void addSession(TimeFrame session)

Adds a session to the strategy. This is called by the underlying study framework.

Parameters:

session - trading session

isEnterOnSessionStart

public boolean isEnterOnSessionStart()

Determines if this strategy should enter automatically when a trading session opens.

Returns:

true if this strategy should enter automatically when a trading session opens.

setEnterOnSessionStart

public void setEnterOnSessionStart(boolean b)

Sets the enter on session start attribute (this is called by the study framework).

Parameters:

b - true if enter on session start is enabled

isCloseOnSessionEnd

public boolean isCloseOnSessionEnd()

Determines if this strategy should exit an open position automatically when a trading session closes.

Returns:

true if this strategy should exit an open position automatically when a trading session closes.

setCloseOnSessionEnd

public void setCloseOnSessionEnd(boolean b)

Sets the close position on session end attribute (this is called by the study framework).

Parameters:

b - true if the close position on session end is enabled

getTimeZone

public java.util.TimeZone getTimeZone()

Gets the timezone for sessions (null for local time zone).

Returns:

timezone for sessions

setTimeZone

public void setTimeZone(java.util.TimeZone tz)

Sets the timezone for sessions (null for local time zone).

Parameters:

tz - time zone

clone

public Settings clone()

Creates a clone (copy) of this object.

Overrides:

clone in class java.lang.Object

Returns:

clone of this object

equals

public boolean equals(java.lang.Object o)

Compares this settings object with the given object and returns true if they are equal.

Overrides:

equals in class java.lang.Object

Parameters:

o - object to compare to

Returns:

true if this object equals the given object

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a property change listener.

Parameters:

listener - property change listener

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a property change listener.

Parameters:

listener - property change listener

removeAllPropertyChangeListeners

public void removeAllPropertyChangeListeners()

Removes all property change listeners.