JumperConnection Class¶
-
class
NXOpen.Routing.Electrical.
JumperConnection
¶ Bases:
NXOpen.Routing.Electrical.PathConnection
A jumper connection connects ports on the same connector.
A path may or may not be associated with this type of connection. Specifies that terminals on the same part instance are connected somehow. See NX Open Routing help for detailed information on the Connection data model.
To create a new instance of this class, use
NXOpen.Routing.Electrical.JumperConnectionCollection.CreateJumperConnection
New in version NX4.0.2.
Properties¶
Property | Description |
---|---|
FromTerminal | Returns or sets the From terminal. |
Guid | Returns or sets the object’s Global Unique Identifier (GUID). |
ImplementedBy | Returns the NXOpen.Routing.RouteObject implementing a connection. |
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
MaximumPathLength | Returns or sets the maximum path length for this connection. |
MinimumPathLength | Returns or sets the minimum path length for this connection. |
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 |
PathLengthMultiplier | Returns or sets the path length multiplier. |
PathLengthOffset | Returns or sets the path length offset. |
Prototype | Returns the prototype of this object if it is an occurrence. |
Tag | Returns the Tag for this object. |
ToTerminal | Returns or sets the To terminal. |
Methods¶
Method | Description |
---|---|
AddFromTerminal | Add Routing.LogicalTerminal to the From Terminals collection. |
AddIntermediateTerminal | Add an intermediate terminal to this connection @return Was the NXOpen.Routing.LogicalTerminal added successfully? |
AddToTerminal | Add Routing.LogicalTerminal to end of the To Terminals collection. |
AssignPath | Assigns the given path to this connection and routes the connection on the path using the given routing level. |
AutomaticallyRoute | Automatically routes this connection on the shortest path using the given routing level. |
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteCharacterstics | Removes the input list of characteristics from this object. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes encountered with the given Type with option to update or not. |
FindFromConnector | Get the From Connector for this connection. |
FindNearestCableDevice | Query this connection to find the nearest harness. |
FindNearestHarnessDevice | Query this connection to find the nearest harness. |
FindNearestParentDevice | Queries this connection for the nearest parent device. |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
FindPaths | Returns all the possible paths this connection can use. |
FindToConnector | Get the To Connector for this connection. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetCharacteristics | Get all of the characteristics values on the this object. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetDestinationCharacteristics | Returns the destination characteristics from the input object. |
GetFromTerminals | Get all From Terminals from the logical connection @return Collection of Routing.LogicalTerminal |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerCharacteristic | Get the value of an integer characteristic associated with the input name. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetIntermediateTerminals | Get the intermediate terminals associated with this connection. |
GetRealAttribute | Gets a real attribute by title. |
GetRealCharacteristic | Get the value of a real characteristic associated with the input name. |
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. |
GetRoutedLevel | Gets the level used to route this connection. |
GetRoutedLevelEnum | Similar to NXOpen.Routing.Electrical.Connection.GetRoutedLevel , but returns the NXOpen.Routing.Electrical.ConnectionRouteLevel enumeration instead of a string. |
GetRoutingMethod | Gets the method used to route this connection. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringCharacteristic | Get the value of a string characteristic associated with the input name. |
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. |
GetToTerminals | Get all To Terminals from the logical connection @return Collection of Routing.LogicalTerminal |
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, of the given type. |
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. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. |
IsRouted | Is this connection routed? @return Is this connection routed? |
Prints a representation of this object to the system log file. | |
RemoveFromTerminal | Remove a Routing.LogicalTerminal from the From Terminals collection. |
RemoveIntermediateTerminal | Remove an intermediate terminal from this connection @return Was the NXOpen.Routing.LogicalTerminal removed successfully? |
RemoveToTerminal | Remove a Routing.LogicalTerminal from the To Terminals collection. |
ReplaceFromTerminals | Replace the existing From Terminals for the logical connection with collection of Routing.LogicalTerminal terminals |
ReplaceIntermediateTerminals | Replaces the intermediate terminals associated with this connection. |
ReplaceToTerminals | Replace the existing To Terminals for the logical connection with collection of Routing.LogicalTerminal terminals |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetCharacteristic | Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already. |
SetCharacteristics | Set all of the characteristics values on this object. |
SetName | Sets the custom name of the 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. |
Unroute | Unroutes this connection. |
Property Detail¶
IsOccurrence¶
-
JumperConnection.
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¶
-
JumperConnection.
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¶
-
JumperConnection.
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¶
-
JumperConnection.
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¶
-
JumperConnection.
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¶
-
JumperConnection.
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¶
DeleteCharacterstics¶
-
JumperConnection.
DeleteCharacterstics
¶ Removes the input list of characteristics from this object.
Signature
DeleteCharacterstics(values)
Parameters: values ( NXOpen.Routing.CharacteristicList
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
FindObject¶
-
JumperConnection.
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.
GetCharacteristics¶
-
JumperConnection.
GetCharacteristics
¶ Get all of the characteristics values on the this object.
Signature
GetCharacteristics()
Returns: Return type: NXOpen.Routing.CharacteristicList
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetDestinationCharacteristics¶
-
JumperConnection.
GetDestinationCharacteristics
¶ Returns the destination characteristics from the input object.
Retrieves the description of which destination characteristics to read from the application view and then reads those destination characteristics from the object
- Ports: Reads characteristics from the port.
- RCPs: Attempts to find a port at the RCP, reads characteristics from
the port if it exists, otherwise reads from the stock associated with the rcp.
- Segments: Reads characteristics from the stock associated with the segment.
- Components: Reads characteristics directly from the component.
- Stock: Reads characteristics from the stock or from the stock’s data.
Signature
GetDestinationCharacteristics()
Returns: Return type: NXOpen.Routing.CharacteristicList
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetIntegerCharacteristic¶
-
JumperConnection.
GetIntegerCharacteristic
¶ Get the value of an integer characteristic associated with the input name.
Signature
GetIntegerCharacteristic(name)
Parameters: name (str) – NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type: int New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetRealCharacteristic¶
-
JumperConnection.
GetRealCharacteristic
¶ Get the value of a real characteristic associated with the input name.
Signature
GetRealCharacteristic(name)
Parameters: name (str) – NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type: float New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetStringCharacteristic¶
-
JumperConnection.
GetStringCharacteristic
¶ Get the value of a string characteristic associated with the input name.
Signature
GetStringCharacteristic(name)
Parameters: name (str) – NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type: str New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
Print¶
-
JumperConnection.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetCharacteristic¶
-
JumperConnection.
SetCharacteristic
¶ Overloaded method SetCharacteristic
SetCharacteristic(name, value)
SetCharacteristic(name, value)
SetCharacteristic(name, value)
-------------------------------------
Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already. Converts the type of an existing characteristic with the same name to integer if it’s type is not integer.
Signature
SetCharacteristic(name, value)
Parameters: - name (str) – NOTE: The full Unicode character set is not supported for this parameter.
- value (int) –
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already. Converts the type of an existing characteristic with the same name to real if it’s type is not real.
Signature
SetCharacteristic(name, value)
Parameters: - name (str) – NOTE: The full Unicode character set is not supported for this parameter.
- value (float) –
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already. Converts the type of an existing characteristic with the same name to string if it’s type is not string.
Signature
SetCharacteristic(name, value)
Parameters: - name (str) – NOTE: The full Unicode character set is not supported for this parameter.
- value (str) – NOTE: The full Unicode character set is not supported for this parameter.
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
SetCharacteristics¶
-
JumperConnection.
SetCharacteristics
¶ Set all of the characteristics values on this object.
Signature
SetCharacteristics(values)
Parameters: values ( NXOpen.Routing.CharacteristicList
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetName¶
-
JumperConnection.
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.