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

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

Inheritance diagram for NXOpen::Routing::StockCollection:
NXOpen::TaggedObjectCollection

List of all members.

Classes

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

Public Member Functions

void AddStock (NXOpen::Routing::CharacteristicList *stockPart, NXOpen::Routing::CharacteristicList *dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const NXString &routeLevel)
 Creates stock on the given segments.
void AddStock (NXOpen::Routing::CharacteristicList *stockPart, NXOpen::Routing::CharacteristicList *dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const NXString &routeLevel, std::vector< NXOpen::Routing::Stock * > &stocks)
 Creates stock Routing::Stock on the given segments.
void AddStock (NXOpen::Routing::CharacteristicList *stockPart, NXOpen::Routing::CharacteristicList *dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const NXString &routeLevel, bool isSpaceReservation, std::vector< NXOpen::Routing::Stock * > &stocks)
 Creates normal or space reservation stock on the given segments.
void AddStock (NXOpen::Routing::CharacteristicList *stockPart, NXOpen::Routing::CharacteristicList *dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const NXString &routeLevel, bool isSpaceReservation, const NXString &anchorName, std::vector< NXOpen::Routing::Stock * > &stocks)
 Creates normal or space reservation stock on the given segments.
iterator begin ()
 Returns an iterator addressing the first element.
void ConvertToStockAsComponents (NXOpen::Routing::ComponentName nameType)
 Converts a part file from Legacy Stock into Stock as Components.
void ConvertToStockAsComponents (bool convertSpaceReservartion, NXOpen::Routing::ComponentName nameType)
 Converts a part file from Legacy Stock into Stock as Components.
std::vector
< NXOpen::Routing::Stock * > 
CreateStock (NXOpen::Routing::StockData *stockData, NXOpen::Routing::Anchor *anchor, NXOpen::Routing::CrossSection *crossSection, const std::vector< NXOpen::Routing::ISegment * > &segments)
 Creates a Routing::Stock object.
iterator end ()
 Returns an iterator addressing one past the last element.
NXOpen::Routing::StockGetComponentStock (NXOpen::Assemblies::Component *component)
 Returns the Routing::Stock that controls the given component.
void RemoveAllFillerStocks (const std::vector< NXOpen::Routing::ISegment * > &segments)
 Removes all filler stocks from the input set of segments.
void RemoveStock (const std::vector< NXOpen::Routing::ISegment * > &segments)
 Removes all stocks (excluding flexed stocks) from the input set of segments.
void RenameStockComponents (const std::vector< NXOpen::Routing::Stock * > &stocks)
 Calls the STOCK_COMPONENT_NAME plugin function to rename a set of stock component parts This method is deprecated.
void ResetReferenceStock ()
 Resets the reference Routing::Stock information to NULL.
void SetAttachedStockLength (NXOpen::Assemblies::Component *partOcc)
 Set the length of the Routing::Stock to which a Assemblies::Component object is attached.
void SetReferenceStockFromObject (NXOpen::NXObject *object)
 Sets the reference Routing::Stock information based on the Routing::Stock associated with this object.
tag_t Tag () const
 Returns the tag of this object.
void UpdateBundleStockForFiller (const std::vector< NXOpen::Routing::ISegment * > &segments)
 Update the bundle stock if the Routing::Filler stock is created underneath it.

Detailed Description

Represents a collection of Routing::Stock objects.


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

Created in NX4.0.0.


Member Function Documentation

void NXOpen::Routing::StockCollection::AddStock ( NXOpen::Routing::CharacteristicList stockPart,
NXOpen::Routing::CharacteristicList dataCharx,
const std::vector< NXOpen::Routing::ISegment * > &  segments,
const NXString routeLevel 
)

Creates stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.
Created in NX5.0.0.

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

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.
segmentssegments
routeLevelRouting level.
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Routing::StockCollection::AddStock ( NXOpen::Routing::CharacteristicList stockPart,
NXOpen::Routing::CharacteristicList dataCharx,
const std::vector< NXOpen::Routing::ISegment * > &  segments,
const NXString routeLevel,
std::vector< NXOpen::Routing::Stock * > &  stocks 
)

Creates stock Routing::Stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path. Returns created stock and number of stock
Created in NX5.0.0.

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

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.
segmentssegments
routeLevelRouting level.
NOTE: The full Unicode character set is not supported for this parameter.
stocksArray of stocks created
void NXOpen::Routing::StockCollection::AddStock ( NXOpen::Routing::CharacteristicList stockPart,
NXOpen::Routing::CharacteristicList dataCharx,
const std::vector< NXOpen::Routing::ISegment * > &  segments,
const NXString routeLevel,
bool  isSpaceReservation,
std::vector< NXOpen::Routing::Stock * > &  stocks 
)

Creates normal or space reservation stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.
Created in NX7.5.2.

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

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.
segmentssegments
routeLevelRouting level.
NOTE: The full Unicode character set is not supported for this parameter.
isSpaceReservationTRUE to create Space Reservation stock, FALSE to create normal stock
stocksArray of stocks created
void NXOpen::Routing::StockCollection::AddStock ( NXOpen::Routing::CharacteristicList stockPart,
NXOpen::Routing::CharacteristicList dataCharx,
const std::vector< NXOpen::Routing::ISegment * > &  segments,
const NXString routeLevel,
bool  isSpaceReservation,
const NXString anchorName,
std::vector< NXOpen::Routing::Stock * > &  stocks 
)

Creates normal or space reservation stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.
Created in NX7.5.2.

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

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.
segmentssegments
routeLevelRouting level.
NOTE: The full Unicode character set is not supported for this parameter.
isSpaceReservationTRUE to create Space Reservation stock, FALSE to create normal stock
anchorNameName of the anchor to use.
NOTE: The full Unicode character set is not supported for this parameter.
stocksArray of stocks created

Returns an iterator addressing the first element.

Converts a part file from Legacy Stock into Stock as Components.

Converts all stocks whose use is NXOpen::Routing::StockUseLegacyStock into NXOpen::Routing::StockUseStockAsComponent stocks by creating components for each stock. After calling this routine, all new stocks in this part will have components associated with them.

Deprecated:
Deprecated in NX8.0.0.


Created in NX4.0.0.

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

Parameters:
nameTypeNaming scheme to use for components. Calls Routing::Stock::RenameComponent on each new stock component if input is Routing::ComponentNamePermanent .

Converts a part file from Legacy Stock into Stock as Components.

Converts all stocks whose use is NXOpen::Routing::StockUseLegacyStock into NXOpen::Routing::StockUseStockAsComponent stocks by creating components for each stock. After calling this routine, all new stocks in this part will have components associated with them.
Created in NX7.5.2.

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

Parameters:
convertSpaceReservartionIf true, convert Space Reservation as Components
nameTypeNaming scheme to use for components. Calls Routing::Stock::RenameComponent on each new stock component if input is Routing::ComponentNamePermanent .

Creates a Routing::Stock object.

Returns:
The resulting array of newly created Routing::Stock objects.
Created in NX4.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
Parameters:
stockDataThe Routing::StockData that defines the stock
anchorThe Routing::Anchor from the input Routing::StockData to use, NULL is allowed for no anchor.
crossSectionThe Routing::CrossSection from the input Routing::StockData to use, NULL is not allowed.
segmentsThe array of Routing::ISegment curves that the stock must cover.

Returns an iterator addressing one past the last element.

Returns the Routing::Stock that controls the given component.

Only returns a Routing::Stock if the input component is a component created by a Stock as Components stock object.

Returns:
Returns NULL if the input component is not controlled by a Routing::Stock
Created in NX4.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
Parameters:
componentcomponent

Removes all filler stocks from the input set of segments.


Created in NX5.0.4.

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

Parameters:
segmentssegments
void NXOpen::Routing::StockCollection::RemoveStock ( const std::vector< NXOpen::Routing::ISegment * > &  segments)

Removes all stocks (excluding flexed stocks) from the input set of segments.


Created in NX5.0.0.

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

Parameters:
segmentssegments

Calls the STOCK_COMPONENT_NAME plugin function to rename a set of stock component parts This method is deprecated.

Use Routing::Stock::RenameStockComponent instead.

Deprecated:
Deprecated in NX7.5.4.


Created in NX5.0.0.

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

Parameters:
stocksstocks

Resets the reference Routing::Stock information to NULL.

The information attributes are rotation, twist, negate, flip, port and anchor. They determine the default creation options for the new stock. This information is used during path creation.
Created in NX5.0.0.

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

Set the length of the Routing::Stock to which a Assemblies::Component object is attached.


Created in NX5.0.0.

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

Parameters:
partOccpart occ

Sets the reference Routing::Stock information based on the Routing::Stock associated with this object.


Created in NX5.0.0.

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

Parameters:
objectobject

Returns the tag of this object.

Update the bundle stock if the Routing::Filler stock is created underneath it.


Created in NX5.0.0.

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

Parameters:
segmentssegments

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