NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::StockBuilder Class Reference

Builder for creating/editing stocks. More...

Inheritance diagram for NXOpen::Routing::StockBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  StockStyleType { StockStyleTypeCenterline, StockStyleTypeSimpleSolid, StockStyleTypeDetailedSolid }
 The stock display style. More...

Public Member Functions

bool FlipStock ()
 Returns the stock flip flag
Created in NX6.0.0.
bool RemoveExistingStock ()
 Returns the remove existing stock flag.
NXOpen::ExpressionRotationValue ()
 Returns the rotation value.
NXOpen::Routing::RouteObjectCollectorSegmentCollector ()
 Returns the routing object collector that collects segments to assign stock to.
void SetFlipStock (bool flipStock)
 Sets the stock flip flag
Created in NX6.0.0.
void SetRemoveExistingStock (bool removeStock)
 Sets the remove existing stock flag.
void SetStockAnchor (const NXString &anchorName)
 Sets the Routing::Anchor name associated with the stock.
void SetStockSettings (NXOpen::Routing::PathStockBuilder *stockBuilder)
 Sets the stock settings for stock assignment.
void SetStockStyle (NXOpen::Routing::StockBuilder::StockStyleType stockStyle)
 Sets the stock style of the stock to assign
Created in NX6.0.0.
void SetSwapProfile (bool swapProfile)
 Sets the profile swap flag.
NXString StockAnchor ()
 Returns the Routing::Anchor name associated with the stock.
NXOpen::Routing::PathStockBuilderStockSettings ()
 Returns the stock settings for stock assignment.
NXOpen::Routing::StockBuilder::StockStyleType StockStyle ()
 Returns the stock style of the stock to assign
Created in NX6.0.0.
bool SwapProfile ()
 Returns the profile swap flag.

Detailed Description

Builder for creating/editing stocks.

Create Stock: Takes a set of segments and assign the selected the stock to the segments. The stock style and orientation settings are optional. Edit Stock: Takes in the selected stock to edit as input and redefines the stock with the new settings.
To create a new instance of this class, use Routing::RouteManager::CreateStockBuilder
Default values.

Property Value

FlipStock

0

RemoveExistingStock

1

RotationValue.Value

0

StockStyle

SimpleSolid

SwapProfile

0


Created in NX6.0.0.


Member Enumeration Documentation

The stock display style.

Enumerator:
StockStyleTypeCenterline 

Centreline.

StockStyleTypeSimpleSolid 

Simple Solid.

StockStyleTypeDetailedSolid 

Detailed Solid.


Member Function Documentation

Returns the stock flip flag
Created in NX6.0.0.



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

Returns the remove existing stock flag.

If set to TRUE the existing stock on the path will be removed when assigning new stock.
Created in NX6.0.0.

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

Returns the rotation value.

Determines the rotation angle of the stock.
Created in NX6.0.0.

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

Returns the routing object collector that collects segments to assign stock to.


Created in NX6.0.0.

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

Sets the stock flip flag
Created in NX6.0.0.



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

Parameters:
flipStockflipstock

Sets the remove existing stock flag.

If set to TRUE the existing stock on the path will be removed when assigning new stock.
Created in NX6.0.0.

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

Parameters:
removeStockremovestock

Sets the Routing::Anchor name associated with the stock.


Created in NX6.0.0.

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

Parameters:
anchorNameanchorname

Sets the stock settings for stock assignment.


Created in NX6.0.0.

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

Parameters:
stockBuilderstockbuilder

Sets the stock style of the stock to assign
Created in NX6.0.0.



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

Parameters:
stockStylestockstyle

Sets the profile swap flag.

Determines whether the profile should be at the path start or end.
Created in NX6.0.0.

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

Parameters:
swapProfileswapprofile

Returns the Routing::Anchor name associated with the stock.


Created in NX6.0.0.

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

Returns the stock settings for stock assignment.


Created in NX6.0.0.

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

Returns the stock style of the stock to assign
Created in NX6.0.0.



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

Returns the profile swap flag.

Determines whether the profile should be at the path start or end.
Created in NX6.0.0.

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


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