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

Represents a collection of Routing::StockData objects. More...

Inheritance diagram for NXOpen::Routing::StockDataCollection:
NXOpen::TaggedObjectCollection

Classes

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

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element.
 
NXOpen::Routing::StockDataCreateStockData (NXOpen::Routing::CharacteristicList *values)
 Creates (or finds an existing Routing::StockData ) object in the work part that has the characteristics specified by the input list of characteristic values.
 
NXOpen::Routing::StockDataCreateStockData ()
 Creates a new stock data in the work part.
 
iterator end ()
 Returns an iterator addressing one past the last element.
 
void RemoveUnusedStockData ()
 Logs for deletion any Routing::StockData objects in the input part not referenced by any Routing::Stock , Routing::Wire and Routing::CrossSection not referenced by any Routing::StockData .
 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a collection of Routing::StockData objects.


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

Created in NX4.0.0.

Member Function Documentation

iterator NXOpen::Routing::StockDataCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Routing::StockData* NXOpen::Routing::StockDataCollection::CreateStockData ( NXOpen::Routing::CharacteristicList values)

Creates (or finds an existing Routing::StockData ) object in the work part that has the characteristics specified by the input list of characteristic values.

Creates the stock by copying the stock defined in the qualified part to the work part. The qualified stock part is specified by the PART_NAME or MEMBER_NAME in the list. If there is no PART_NAME or MEMBER_NAME a stock data, the OD or WIDTH/HEIGHT values are used to generate either a circular or rectangular stock data.
Use this routine to create stock data's in the work part in order to create stocks. Use Routing::RouteManager::SetPartTypeFlag to create a qualified stock data part.

Example Use:

values = theSession.Preferences.RoutingApplicationView.PartPreferences.PartLibrary.CreateCriteria ( );
values.SetCharacteristic ( "OD", 10.0 );
stock_data = workPart.RouteManager.StockDataCollection.CreateStockData ( values );
stocks = workPart.RouteManager.StockCollection.CreateStock ( stock_data, anchor, cross_section, segments );
workPart.RouteManager.SetPartTypeFlag( Routing.RouteManager.PartType.Stock );


Returns

Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
valuesvalues
NXOpen::Routing::StockData* NXOpen::Routing::StockDataCollection::CreateStockData ( )

Creates a new stock data in the work part.

The new stock data contains all of the Routing::CrossSection and Routing::Anchor objects in the work part. After calling this routine call Routing::RouteManager::SetPartTypeFlag to NXOpen::Routing::RouteManager::PartTypeStock , NXOpen::Routing::RouteManager::PartTypeOverstock , or NXOpen::Routing::RouteManager::PartTypeFiller to properly qualify this as a stock definition part.

Returns

Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
iterator NXOpen::Routing::StockDataCollection::end ( )

Returns an iterator addressing one past the last element.

void NXOpen::Routing::StockDataCollection::RemoveUnusedStockData ( )

Logs for deletion any Routing::StockData objects in the input part not referenced by any Routing::Stock , Routing::Wire and Routing::CrossSection not referenced by any Routing::StockData .


Created in NX5.0.0.

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

tag_t NXOpen::Routing::StockDataCollection::Tag ( ) const

Returns the tag of this object.


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