PortConnectionBuilder Class¶
-
class
NXOpen.AME.
PortConnectionBuilder
¶ Bases:
NXOpen.Builder
builder for the port connector dialog
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreatePortConnectionBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
SelectedSourcePort | Returns the source port |
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. |
Disconnect | Disconnects given ports each other |
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. |
SetTargetPorts | Sets ports to connect |
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¶
SelectedSourcePort¶
-
PortConnectionBuilder.
SelectedSourcePort
¶ Returns the source port
-------------------------------------
Getter Method
Signature
SelectedSourcePort
Returns: Return type: NXOpen.AME.SelectAMEBaseNode
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Disconnect¶
-
PortConnectionBuilder.
Disconnect
¶ Overloaded method Disconnect
Disconnect(port1, port2)
Disconnect(portToDisconnect)
-------------------------------------
Disconnects given ports each other
Signature
Disconnect(port1, port2)
Parameters: - port1 (
NXOpen.NXObject
) – - port2 (
NXOpen.NXObject
) –
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Disconnects given port
Signature
Disconnect(portToDisconnect)
Parameters: portToDisconnect ( NXOpen.NXObject
) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
SetTargetPorts¶
-
PortConnectionBuilder.
SetTargetPorts
¶ Sets ports to connect
Signature
SetTargetPorts(ports)
Parameters: ports (list of NXOpen.NXObject
) – The ports tag arrayNew in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
PortConnectionBuilder.
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.