Class DoubleDescriptor
java.lang.Object
com.motivewave.platform.sdk.common.desc.SettingDescriptor<Double>
com.motivewave.platform.sdk.common.desc.DoubleDescriptor
Describes a double value that is part of the study/strategy settings.
These values may be given a minimum, maximum and step value.
-
Constructor Summary
ConstructorDescriptionDoubleDescriptor
(String name, String label, double defaultValue, double minValue, double maxValue, double step) Constructor -
Method Summary
Modifier and TypeMethodDescriptionjavafx.scene.Node
createInputFX
(Settings settings, boolean readOnly) Creates the component that will accept the user input.Gets the default value for this setting.double
Gets the maximum allowable value.double
Gets the minimum allowable value.double
getStep()
Gets the incremental step.Methods inherited from class com.motivewave.platform.sdk.common.desc.SettingDescriptor
createInput, createTBInput, getDescription, getGridWidth, getHelpLink, getIconFactory, getId, getLabel, getName, isAllowUserDefaults, isDisplaySetting, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setDescription, setEnabled, setGridWidth, setHelpLink, setIconFactory, setShowLabel, setSupportsDisable
-
Constructor Details
-
DoubleDescriptor
public DoubleDescriptor(String name, String label, double defaultValue, double minValue, double maxValue, double step) Constructor- Parameters:
name
- name of this setting (key)label
- label displayed to the userdefaultValue
- default double valueminValue
- minimum double valuemaxValue
- maximum double valuestep
- step increment
-
-
Method Details
-
getDefaultValue
Gets the default value for this setting.- Overrides:
getDefaultValue
in classSettingDescriptor<Double>
- Returns:
- default value for the setting
-
createInputFX
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 classSettingDescriptor<Double>
- Parameters:
settings
- settings for the studyreadOnly
- true if the component should not accept user input- Returns:
- component that will accept user input.
-
getMinValue
public double getMinValue()Gets the minimum allowable value. -
getMaxValue
public double getMaxValue()Gets the maximum allowable value. -
getStep
public double getStep()Gets the incremental step. -
fromJson
- Overrides:
fromJson
in classSettingDescriptor<Double>
-