CustomFeatureParameter.value Property

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Gets and sets the real value (a double) of the parameter in database units. Setting this property will set/reset the expression value for this parameter.

This property is only valid for numeric parameters and will fail for text parameters. You can determine the value type of the parameter by using the valueType property. Use the textValue property to get and set the value of text parameters.

Syntax

# Get the value of the property.
propertyValue = customFeatureParameter_var.value

# Set the value of the property.
customFeatureParameter_var.value = propertyValue

#include <Fusion/Features/CustomFeatureParameter.h>

// Get the value of the property.
double propertyValue = customFeatureParameter_var->value();

// Set the value of the property, where value_var is a double.
bool returnValue = customFeatureParameter_var->value(value_var);

Property Value

Version