NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Routing::Electrical::SortConnectionsPluginData Class Reference

Data object created by Routing just before routing connections. More...

Inheritance diagram for NXOpen::Routing::Electrical::SortConnectionsPluginData:
NXOpen::TaggedObject

Public Member Functions

void GetStockDevicesToSort (std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &stockDevices)
 Gets the stock devices such as Routing::Electrical::WireDevice s that implement connections Routing is about to route along their paths. More...
 
void SetSortedStockDevices (const std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &stockDevices)
 Sets the stock devices sorted in the order in which you want their connections to route. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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.

Created in NX12.0.0.

Member Function Documentation

void NXOpen::Routing::Electrical::SortConnectionsPluginData::GetStockDevicesToSort ( std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &  stockDevices)

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


Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
stockDevicesThe Routing::Electrical::ElectricalStockDevice s to sort in the order in which you want to route them.
void NXOpen::Routing::Electrical::SortConnectionsPluginData::SetSortedStockDevices ( const std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &  stockDevices)

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


Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
stockDevicesThe Routing::Electrical::ElectricalStockDevice s sorted in the order in which you want to route them.

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.