PortConnection Class¶
-
class
NXOpen.Routing.
PortConnection
¶ Bases:
NXOpen.NXObject
The Routing PortConnection object is used by Routing to position ports while placing parts.
To create a new instance of this class, use
NXOpen.Routing.PortConnectionCollection.CreatePortConnection()
New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Name | Returns the custom name of the object. |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
Prototype | Returns the prototype of this object if it is an occurrence. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
ArePortsAligned | Returns whether the ports in the port connection are aligned correctly. |
CreateAttributeIterator | Create an attribute iterator @return A new attribute iterator object |
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
ForceValid | Force the connection to be valid regardless of the port alignment or the overridden value. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetEngagement | Returns the engagement distance between the two ports connected by a Port Connection object. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
GetOverriddenValidity | Returns the overridden validity value of the port connection. |
GetOverrideReason | Gets the reason why a port connection’s validity was overridden. |
GetPorts | Returns the two ports connected by a Port Connection object. |
GetRealAttribute | Gets a real attribute by title. |
GetRealUserAttribute | Gets a real attribute by Title and array Index. |
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetTimeAttribute | Gets a time attribute by title. |
GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator. |
GetUserAttributeLock | Determine the lock of the given attribute. |
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator @return |
IsForcedValid | Returns whether the connection is forced to be valid. |
IsValid | Returns whether the connection is valid. |
OverrideValidity | Overrides the validity of the port connection. |
Prints a representation of this object to the system log file. | |
RemoveForcedValidity | Removes the forced validity setting on the connection. |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetEngagement | Sets the engagement distance between the two ports connected by a Port Connection object. |
SetName | Sets the custom name of the object. |
SetOverrideReason | Sets the reason why a port connection’s validity was overridden. |
SetPorts | Sets the link between the two ports connected by the Port Connection object. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetTimeAttribute | Creates or modifies a time attribute. |
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
SetUserAttributeLock | Lock or unlock the given attribute. |
Enumerations¶
PortConnectionOverriddenValidity Enumeration | Overridden port connection validity |
Property Detail¶
IsOccurrence¶
-
PortConnection.
IsOccurrence
¶ Returns whether this object is an occurrence or not.
-------------------------------------
Getter Method
Signature
IsOccurrence()
Returns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
PortConnection.
JournalIdentifier
¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------
Getter Method
Signature
JournalIdentifier()
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
PortConnection.
Name
¶ Returns the custom name of the object.
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
PortConnection.
OwningComponent
¶ Returns the owning component, if this object is an occurrence.
-------------------------------------
Getter Method
Signature
OwningComponent()
Returns: Return type: NXOpen.Assemblies.Component
New in version NX3.0.0.
License requirements: None.
OwningPart¶
-
PortConnection.
OwningPart
¶ Returns the owning part of this object
-------------------------------------
Getter Method
Signature
OwningPart()
Returns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePart
New in version NX3.0.0.
License requirements: None.
Prototype¶
-
PortConnection.
Prototype
¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------
Getter Method
Signature
Prototype()
Returns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
Method Detail¶
ArePortsAligned¶
-
PortConnection.
ArePortsAligned
¶ Returns whether the ports in the port connection are aligned correctly.
Both direction and rotation are evaluated.
Signature
ArePortsAligned()
Returns: validity of the current connection. Return type: bool New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
FindObject¶
-
PortConnection.
FindObject
¶ Finds the
NXOpen.NXObject
with the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)
Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
ForceValid¶
-
PortConnection.
ForceValid
¶ Force the connection to be valid regardless of the port alignment or the overridden value.
The user’s login name and the date and time are recorded automatically along with the given reason.
Signature
ForceValid(reason)
Parameters: reason (str) – The reason why this connection was forced to be valid. New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
GetEngagement¶
-
PortConnection.
GetEngagement
¶ Returns the engagement distance between the two ports connected by a Port Connection object.
Signature
GetEngagement()
Returns: engagement distance between the ports connected by the Port Connection object :rtype: float
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetOverriddenValidity¶
-
PortConnection.
GetOverriddenValidity
¶ Returns the overridden validity value of the port connection.
Signature
GetOverriddenValidity()
Returns: overridden validity value. Return type: NXOpen.Routing.PortConnectionOverriddenValidity
New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
GetOverrideReason¶
-
PortConnection.
GetOverrideReason
¶ Gets the reason why a port connection’s validity was overridden.
Signature
GetOverrideReason()
Returns: The reason why this connection’s validity was overridden. Return type: str New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
GetPorts¶
-
PortConnection.
GetPorts
¶ Returns the two ports connected by a Port Connection object.
Signature
GetPorts()
Returns: a tuple Return type: A tuple consisting of (port1, port2). port1 is a NXOpen.Routing.Port
. first Port connected by the Port Connection object port2 is aNXOpen.Routing.Port
. second Port connected by the Port Connection objectNew in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
IsForcedValid¶
-
PortConnection.
IsForcedValid
¶ Returns whether the connection is forced to be valid.
Signature
IsForcedValid()
Returns: validity of the current connection. Return type: bool New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
IsValid¶
-
PortConnection.
IsValid
¶ Returns whether the connection is valid.
Validity is initially determined by the alignment of the ports but can be overridden by OverrideValidity or ForceValid
Signature
IsValid()
Returns: validity of the current connection. Return type: bool New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
OverrideValidity¶
-
PortConnection.
OverrideValidity
¶ Overrides the validity of the port connection.
By default, the validity is determined by evaluating the alignment of the connected ports.
Signature
OverrideValidity(overriddenValidity)
Parameters: overriddenValidity ( NXOpen.Routing.PortConnectionOverriddenValidity
) – overridden validity value.New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
Print¶
-
PortConnection.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
RemoveForcedValidity¶
-
PortConnection.
RemoveForcedValidity
¶ Removes the forced validity setting on the connection.
Validity will now be determined based on the alignment or on the overridden validity setting.
Signature
RemoveForcedValidity()
New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
SetEngagement¶
-
PortConnection.
SetEngagement
¶ Sets the engagement distance between the two ports connected by a Port Connection object.
Signature
SetEngagement(engagement)
Parameters: engagement (float) – engagement distance to be set between the ports connected by the Port Connection object New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetName¶
-
PortConnection.
SetName
¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)
Parameters: name (str) – New in version NX3.0.0.
License requirements: None.
SetOverrideReason¶
-
PortConnection.
SetOverrideReason
¶ Sets the reason why a port connection’s validity was overridden.
Signature
SetOverrideReason(reason)
Parameters: reason (str) – The reason why this connection’s validity was overridden. New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
SetPorts¶
-
PortConnection.
SetPorts
¶ Sets the link between the two ports connected by the Port Connection object.
Signature
SetPorts(port1, port2)
Parameters: - port1 (
NXOpen.Routing.Port
) – first port to be connected by the Port Connection object - port2 (
NXOpen.Routing.Port
) – second port to be connected by the Port Connection object
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
- port1 (