SortConnectionsPluginData Class¶

class NXOpen.Routing.Electrical.SortConnectionsPluginData¶

Data object created by Routing just before routing connections.

Routing sends this object to any registered Sort Connections plugin with the “Stock Devices to sort” filled in.

It is the Sort Connections plugin responsibility to sort the Stock Devices and to put the sorted Stock Devices into “Sorted Stock Devices”.

For more information, see Routing.CustomManager and the Routing.CustomManager.SetSortConnectionsPlugin()

An instance of this object will be sent to the Sort Connections plugin.

New in version NX12.0.0.

Properties¶

Property	Description
Tag	Returns the Tag for this object.

Method	Description
GetStockDevicesToSort	Gets the stock devices such as :py:class:`Routing.Electrical.WireDevice`s that implement connections Routing is about to route along their paths.
SetSortedStockDevices	Sets the stock devices sorted in the order in which you want their connections to route.

SortConnectionsPluginData.GetStockDevicesToSort¶

Gets the stock devices such as :py:class:`Routing.Electrical.WireDevice`s that implement connections Routing is about to route along their paths.

Signature GetStockDevicesToSort()

Returns:	The :py:class:`Routing.Electrical.ElectricalStockDevice`s to sort in the order in which

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SortConnectionsPluginData.SetSortedStockDevices¶

Sets the stock devices sorted in the order in which you want their connections to route.

Signature SetSortedStockDevices(stockDevices)

Parameters:	stockDevices (list of `NXOpen.Routing.Electrical.ElectricalStockDevice`) – The :py:class:`Routing.Electrical.ElectricalStockDevice`s sorted in the order in which you want to route them.

New in version NX12.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)