BulkConnectionBuilder Class¶
-
class
NXOpen.AME.BulkConnectionBuilder¶ Bases:
NXOpen.Builderbuilder for the bulk connection dialog
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateBulkConnectionBuilder()New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| SourceObject | Returns the source object |
| Tag | Returns the Tag for this object. |
| TargetObject | Returns the target object |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| ConnectOneToOne | Make the Connection between the source and target ports |
| ConnectOneVsMany | Make the Connection between 1 port of N cardinality and Many ports of 1 cardinality |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| Disconnect | Disconnect the Connections |
| 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¶
SourceObject¶
-
BulkConnectionBuilder.SourceObject¶ Returns the source object
-------------------------------------Getter Method
Signature
SourceObjectReturns: Return type: NXOpen.SelectNXObjectListNew in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
TargetObject¶
-
BulkConnectionBuilder.TargetObject¶ Returns the target object
-------------------------------------Getter Method
Signature
TargetObjectReturns: Return type: NXOpen.SelectNXObjectListNew in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
ConnectOneToOne¶
-
BulkConnectionBuilder.ConnectOneToOne¶ Make the Connection between the source and target ports
Signature
ConnectOneToOne(sourcePorts, targetPorts, overrideExistingConnection)Parameters: - sourcePorts (list of
NXOpen.NXObject) – The ports tag array - targetPorts (list of
NXOpen.NXObject) – The ports tag array - overrideExistingConnection (bool) –
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
- sourcePorts (list of
ConnectOneVsMany¶
-
BulkConnectionBuilder.ConnectOneVsMany¶ Make the Connection between 1 port of N cardinality and Many ports of 1 cardinality
Signature
ConnectOneVsMany(sourcePorts, targetPorts, overrideExistingConnection)Parameters: - sourcePorts (list of
NXOpen.NXObject) – The ports tag array - targetPorts (list of
NXOpen.NXObject) – The ports tag array - overrideExistingConnection (bool) –
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
- sourcePorts (list of
Disconnect¶
-
BulkConnectionBuilder.Disconnect¶ Disconnect the Connections
Signature
Disconnect(sourcePorts, targetPorts)Parameters: - sourcePorts (list of
NXOpen.AME.IPort) – The source ports of connections, to be disconnect - targetPorts (list of
NXOpen.AME.IPort) – The target ports of connections, to be disconnect
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
- sourcePorts (list of
Validate¶
-
BulkConnectionBuilder.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.