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

Class QuantityDescriptor

java.lang.Object

com.motivewave.platform.sdk.common.desc.SettingDescriptor<Double>

com.motivewave.platform.sdk.common.desc.QuantityDescriptor

public class QuantityDescriptor
extends SettingDescriptor<Double>

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

Constructors

Constructor	Description
QuantityDescriptor(String name, String label, double defaultValue)	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)
Double	getDefaultValue()	Gets the default value for this setting.
double	getMaxValue()	Gets the maximum allowable value.
double	getMinValue()	Gets the minimum allowable value.
double	getStep()	Gets the incremental step.
void	setMaxValue(double max)	Sets the maximum allowable value.
void	setMinValue(double min)	Sets the minimum allowable value.
void	setStep(double step)	Sets 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

Methods inherited from class java.lang.Object

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

Constructor Details

QuantityDescriptor

public QuantityDescriptor(String name,
 String label,
 double defaultValue)

Constructor

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default double value

minValue - minimum double value

maxValue - maximum double value

account - step increment

Method Details

getDefaultValue

public Double getDefaultValue()

Gets the default value for this setting.

Overrides:

getDefaultValue in class SettingDescriptor<Double>

Returns:

default value for the setting

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<Double>

Parameters:

settings - settings for the study

readOnly - 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.

setMinValue

public void setMinValue(double min)

Sets the minimum allowable value. This should be called by the underlying framework only.

getMaxValue

public double getMaxValue()

Gets the maximum allowable value.

setMaxValue

public void setMaxValue(double max)

Sets the maximum allowable value. This should be called by the underlying framework only.

getStep

public double getStep()

Gets the incremental step.

setStep

public void setStep(double step)

Sets the incremental step. This should be called by the underlying framework only.

fromJson

public Object fromJson(Object json)

Overrides:

fromJson in class SettingDescriptor<Double>