NX Open C++ Reference Guide
Classes | Public Member Functions
NXOpen::Routing::Electrical::ElectricalStockDeviceCollection Class Reference

Represents a collection of Routing::Electrical::ElectricalStockDevice (ESD) objects. More...

Inheritance diagram for NXOpen::Routing::Electrical::ElectricalStockDeviceCollection:
NXOpen::TaggedObjectCollection

List of all members.

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...

Public Member Functions

void AssignStock (const std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &stockDevices, NXOpen::Routing::Electrical::ElectricalStockDevice::RouteTypes routeType)
 Assign Routing::Stock to input stock devices.
int AutoRouteAll (NXOpen::Routing::Electrical::ElectricalStockDevice::RouteLevel routeLevel, NXOpen::Routing::Electrical::ElectricalStockDevice::AutoRouteSel routeSel, NXOpen::ErrorList **errorList)
 Automatically routes all of the stock devices in the work part.
int AutoRouteConnections (NXOpen::Routing::Electrical::ElectricalStockDevice::RouteLevel routeLevel, NXOpen::Routing::Electrical::ElectricalStockDevice::AutoRouteSel routeSel, const std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &stockDevices, NXOpen::ErrorList **errorList)
 Automatically routes the selected stock devices.
iterator begin ()
 Returns an iterator addressing the first element.
iterator end ()
 Returns an iterator addressing one past the last element.
std::vector
< NXOpen::Routing::Electrical::ElectricalStockDevice * > 
RemoveStock (const std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &stockDevices)
 Removes Routing::Stock from input stock devices.
tag_t Tag () const
 Returns the tag of this object.
std::vector
< NXOpen::Routing::Electrical::ElectricalStockDevice * > 
Unroute (const std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &stockDevices)
 Removes all bundle Routing::Stock from input stock devices.
std::vector
< NXOpen::Routing::Electrical::ElectricalStockDevice * > 
UnrouteAll ()
 Removes all bundle Routing::Stock from all stock devices.

Detailed Description

Represents a collection of Routing::Electrical::ElectricalStockDevice (ESD) objects.


To obtain an instance of this class, refer to Routing::RouteManager

Created in NX4.0.2.


Member Function Documentation

Assign Routing::Stock to input stock devices.

The assigned Routing::Stock is a bundle stock, and the routine will perform the bundling calculations. This routine should also be called after performing Routing::Electrical::ElectricalStockDevice::ManuallyRoute .
Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
stockDevicesstock devices
routeTyperoute type

Automatically routes all of the stock devices in the work part.

Routing can be done on pin, component or mixed level and it is based on shortest length (See Routing::Electrical::ElectricalStockDevice for more details).

Returns:

Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
routeLevelroute level
routeSelroute sel
errorListAny errors that occurred during Automatic Routing.

Automatically routes the selected stock devices.

Routing can be done on pin, component or mixed level and it is based on shortest length (See Routing::Electrical::ElectricalStockDevice for more details).

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
routeLevelroute level
routeSelroute sel
stockDevicesstock devices
errorListAny errors that occurred during Automatic Routing.

Returns an iterator addressing the first element.

Returns an iterator addressing one past the last element.

Removes Routing::Stock from input stock devices.

Removes all segments from input wires and updates harnesses associated to wires, resizes and rebuilds bundle stocks for those harnesses. Deletes the Routing::Wire .

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
stockDevicesstock devices

Returns the tag of this object.

Removes all bundle Routing::Stock from input stock devices.

Removes all segments from input wires and updates harnesses associated to wires, resizes and rebuilds bundle stocks for those harnesses. Deletes the Routing::Wire . Use this when no rebundling is necessary

Returns:

Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
stockDevicesstock devices

Removes all bundle Routing::Stock from all stock devices.

Removes all segments from input wires and updates harnesses associated to wires, resizes and rebuilds bundle stocks for those harnesses. Deletes the Routing::Wire . Use this when no rebundling is necessary

Returns:

Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

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