NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
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

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

void NXOpen::Routing::Electrical::ElectricalStockDeviceCollection::AssignStock ( const std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &  stockDevices,
NXOpen::Routing::Electrical::ElectricalStockDevice::RouteTypes  routeType 
)

Assign Routing::Stock to input stock devices.

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


Created in NX5.0.0.

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

Parameters
stockDevicesstock devices
routeTyperoute type
int NXOpen::Routing::Electrical::ElectricalStockDeviceCollection::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.

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_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
routeLevelroute level
routeSelroute sel
errorListAny errors that occurred during Automatic Routing.
int NXOpen::Routing::Electrical::ElectricalStockDeviceCollection::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.

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_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
routeLevelroute level
routeSelroute sel
stockDevicesstock devices
errorListAny errors that occurred during Automatic Routing.
iterator NXOpen::Routing::Electrical::ElectricalStockDeviceCollection::begin ( )

Returns an iterator addressing the first element.

iterator NXOpen::Routing::Electrical::ElectricalStockDeviceCollection::end ( )

Returns an iterator addressing one past the last element.

std::vector<NXOpen::Routing::Electrical::ElectricalStockDevice *> NXOpen::Routing::Electrical::ElectricalStockDeviceCollection::RemoveStock ( const std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &  stockDevices)

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 @link Routing::Wire Routing::Wire@endlink .  @return  


Created in NX5.0.0.

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

Parameters
stockDevicesstock devices
tag_t NXOpen::Routing::Electrical::ElectricalStockDeviceCollection::Tag ( ) const

Returns the tag of this object.

std::vector<NXOpen::Routing::Electrical::ElectricalStockDevice *> NXOpen::Routing::Electrical::ElectricalStockDeviceCollection::Unroute ( const std::vector< NXOpen::Routing::Electrical::ElectricalStockDevice * > &  stockDevices)

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 @link Routing::Wire Routing::Wire@endlink . Use this when no rebundling is 
           necessary  @return  


Created in NX6.0.0.

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

Parameters
stockDevicesstock devices
std::vector<NXOpen::Routing::Electrical::ElectricalStockDevice *> NXOpen::Routing::Electrical::ElectricalStockDeviceCollection::UnrouteAll ( )

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 @link Routing::Wire Routing::Wire@endlink . Use this when no rebundling is 
           necessary  @return  


Created in NX6.0.0.

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


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