AdapterFormulaBuilder Class¶
-
class
NXOpen.Mechatronics.AdapterFormulaBuilder¶ Bases:
NXOpen.Mechatronics.RuntimeFormulaBuilderRepresents a
NXOpen.Mechatronics.AdapterFormulaBuilder.To create a new instance of this class, use
NXOpen.Mechatronics.AdapterFormulaCollection.CreateAdapterFormulaBuilder()New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| DestPropertyId | Returns or sets the dest property id |
| FormulaComment | Returns or sets the formula comment. |
| 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¶
FormulaComment¶
-
AdapterFormulaBuilder.FormulaComment¶ Returns or sets the formula comment.
-------------------------------------Getter Method
Signature
FormulaCommentReturns: Return type: str New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
FormulaCommentParameters: formulaComment (str) – New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
AdapterFormulaBuilder.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.