RuntimeFormulaBuilder Class

class NXOpen.Mechatronics.RuntimeFormulaBuilder

Bases: NXOpen.Builder

Represents a Mechatronics.RuntimeFormulaBuilder.

To create a new instance of this class, use NXOpen.Mechatronics.RuntimeFormulaCollection.CreateRuntimeFormulaBuilder()

New in version NX8.5.0.

Properties

Property	Description
DestPropertyId	Returns or sets the dest property id
FormulaName	Returns or sets the formula name
FormulaString	Returns or sets the formula string
ObjectToAssignParamSelection	Returns the object to assign param selection
ParameterBuilderList	Returns the formula parameter list.
SelectionInputObject	Returns the inuput object selection
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

DestPropertyId

RuntimeFormulaBuilder.DestPropertyId

Returns or sets the dest property id

-------------------------------------

Getter Method

Signature DestPropertyId

Returns: Return type:int

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature DestPropertyId

Parameters:destPropertyId (int) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

FormulaName

RuntimeFormulaBuilder.FormulaName

Returns or sets the formula name

-------------------------------------

Getter Method

Signature FormulaName

Returns: Return type:str

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature FormulaName

Parameters:formulaName (str) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

FormulaString

RuntimeFormulaBuilder.FormulaString

Returns or sets the formula string

-------------------------------------

Getter Method

Signature FormulaString

Returns: Return type:str

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature FormulaString

Parameters:formulaString (str) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ObjectToAssignParamSelection

RuntimeFormulaBuilder.ObjectToAssignParamSelection

Returns the object to assign param selection

-------------------------------------

Getter Method

Signature ObjectToAssignParamSelection

Returns: Return type:NXOpen.SelectNXObject

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ParameterBuilderList

RuntimeFormulaBuilder.ParameterBuilderList

Returns the formula parameter list.

-------------------------------------

Getter Method

Signature ParameterBuilderList

Returns: Return type:NXOpen.Mechatronics.RuntimeFormulaParameterBuilderList

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SelectionInputObject

RuntimeFormulaBuilder.SelectionInputObject

Returns the inuput object selection

-------------------------------------

Getter Method

Signature SelectionInputObject

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

Validate

RuntimeFormulaBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.