FunctionCallInstanceBuilder Class¶
-
class
NXOpen.AME.FunctionCallInstanceBuilder¶ Bases:
NXOpen.BuilderJA class for the reuse rule dialog
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateFunctionCallInstanceBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| EoDataItemAttributeHolder | Returns the data item |
| InstanceName | Returns or sets the defined idb text name |
| SelectedAspectBlock | Returns the EngObject selection |
| SelectedBlock | Returns the PlcBlock 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. |
| SetSymbolicName | Updates the idb symbolic name |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UpdateSourceBlock | Updates the source block selection |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
EoDataItemAttributeHolder¶
-
FunctionCallInstanceBuilder.EoDataItemAttributeHolder¶ Returns the data item
-------------------------------------Getter Method
Signature
EoDataItemAttributeHolderReturns: Return type: NXOpen.AME.EODataItemAttributeHolderNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
InstanceName¶
-
FunctionCallInstanceBuilder.InstanceName¶ Returns or sets the defined idb text name
-------------------------------------Getter Method
Signature
InstanceNameReturns: Return type: str New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
InstanceNameParameters: resultText (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedAspectBlock¶
-
FunctionCallInstanceBuilder.SelectedAspectBlock¶ Returns the EngObject selection
-------------------------------------Getter Method
Signature
SelectedAspectBlockReturns: Return type: NXOpen.AME.SelectAspectNodeNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedBlock¶
-
FunctionCallInstanceBuilder.SelectedBlock¶ Returns the PlcBlock selection
-------------------------------------Getter Method
Signature
SelectedBlockReturns: Return type: NXOpen.AME.SelectAMEBaseNodeNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
SetSymbolicName¶
-
FunctionCallInstanceBuilder.SetSymbolicName¶ Updates the idb symbolic name
Signature
SetSymbolicName(symbolicName)Parameters: symbolicName (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
UpdateSourceBlock¶
-
FunctionCallInstanceBuilder.UpdateSourceBlock¶ Updates the source block selection
Signature
UpdateSourceBlock(selBlock)Parameters: selBlock ( NXOpen.AME.PlcBlock) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
FunctionCallInstanceBuilder.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.