Package com.motivewave.platform.sdk.common.desc

Class InstrumentDescriptor

java.lang.Object

com.motivewave.platform.sdk.common.desc.SettingDescriptor

com.motivewave.platform.sdk.common.desc.InstrumentDescriptor

public class InstrumentDescriptor
extends SettingDescriptor

Describes an input for selecting an instrument that is part of the study/strategy. Please Note: you must declare 'multipleInstrument=true' in the study header in order for data to be returned at runtime.

Constructor Summary

Constructors

Constructor	Description
InstrumentDescriptor(String name, String label)	Constructor.
InstrumentDescriptor(String name, String label, boolean chartInstrumentDefault, boolean supportsChartInstrument)	Constructor.

Method Summary

Modifier and Type	Method	Description
javafx.scene.Node	createInputFX(Settings settings, boolean readOnly)	Creates the component that will accept the user input.
Object	fromJson(Object json)
boolean	isChartInstrumentDefault()	Gets the default attribute for using the chart instrument.
boolean	supportsChartInstrument()	Indicates if the input supports specifying the chart instrument.

Methods inherited from class com.motivewave.platform.sdk.common.desc.SettingDescriptor

createInput, createTBInput, getDefaultValue, getDescription, getGridWidth, getHelpLink, getIconFactory, getId, getLabel, getName, isAllowUserDefaults, isDisplaySetting, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setDescription, setEnabled, setGridWidth, setHelpLink, setIconFactory, setShowLabel, setSupportsDisable

Methods inherited from class java.lang.Object

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

Constructor Details

InstrumentDescriptor

public InstrumentDescriptor(String name,
 String label)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

InstrumentDescriptor

public InstrumentDescriptor(String name,
 String label,
 boolean chartInstrumentDefault,
 boolean supportsChartInstrument)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

Method Details

createInputFX

public javafx.scene.Node createInputFX(Settings settings,
 boolean readOnly)

Description copied from class: SettingDescriptor

Creates the component that will accept the user input. This is called by the study framework.

Specified by:

createInputFX in class SettingDescriptor

Parameters:

settings - settings for the study

readOnly - true if the component should not accept user input

Returns:

component that will accept user input.

supportsChartInstrument

public boolean supportsChartInstrument()

Indicates if the input supports specifying the chart instrument.

Returns:

true if the input allows the user to specify the chart instrument

isChartInstrumentDefault

public boolean isChartInstrumentDefault()

Gets the default attribute for using the chart instrument.

Returns:

true if the chart instrument should be used by default

fromJson

public Object fromJson(Object json)

Overrides:

fromJson in class SettingDescriptor