ArrangeDefinition2DInput.globalQuantity 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 global quantity, which is the default quantity value for components. This defaults to 1.

This value will become a parameter when the arrangement is created. When created with a real value it must be a whole number. You can also use a string where it is interpreted the same as when entered in the command dialog. The expression must result in a unitless whole number. It's also possible to use an equation like "Total / 4" where "Total" is an existing parameter and be evenly divided by four.

Syntax

# Get the value of the property.
propertyValue = arrangeDefinition2DInput_var.globalQuantity

# Set the value of the property.
arrangeDefinition2DInput_var.globalQuantity = propertyValue

#include <Fusion/Arrange/ArrangeDefinition2DInput.h>

// Get the value of the property.
Ptr<ValueInput> propertyValue = arrangeDefinition2DInput_var->globalQuantity();

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

Property Value

Version