Builder for creating/editing stocks. More...

Inheritance diagram for NXOpen::Routing::StockBuilder:

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::Expression *	RotationValue ()
	Returns the rotation value.

NXOpen::Routing::RouteObjectCollector *	SegmentCollector ()
	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	SetStockAnchor (const char *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::PathStockBuilder *	StockSettings ()
	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.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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.
 <br> To create a new instance of this class, use @link Routing::RouteManager::CreateStockBuilder  Routing::RouteManager::CreateStockBuilder @endlink  <br>

Default values.

Property

Value

FlipStock

0

RemoveExistingStock

1

RotationValue.Value

0

StockStyle

SimpleSolid

SwapProfile

0

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Routing::StockBuilder::StockStyleType

The stock display style.

Enumerator:

StockStyleTypeCenterline	Centreline.
StockStyleTypeSimpleSolid	Simple Solid.
StockStyleTypeDetailedSolid	Detailed Solid.

Member Function Documentation

bool NXOpen::Routing::StockBuilder::FlipStock ( )

Returns the stock flip flag
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::StockBuilder::RemoveExistingStock ( )

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_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::StockBuilder::RotationValue ( )

Returns the rotation value.

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

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::RouteObjectCollector* NXOpen::Routing::StockBuilder::SegmentCollector ( )

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

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::StockBuilder::SetFlipStock ( bool flipStock )

Sets the stock flip flag
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

flipStock flipstock

void NXOpen::Routing::StockBuilder::SetRemoveExistingStock ( bool removeStock )

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_base ("Routing Basic")

Parameters

removeStock removestock

void NXOpen::Routing::StockBuilder::SetStockAnchor ( const NXString & anchorName )

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

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

anchorName anchorname

void NXOpen::Routing::StockBuilder::SetStockAnchor ( const char * anchorName )

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

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

anchorName anchorname

void NXOpen::Routing::StockBuilder::SetStockSettings ( NXOpen::Routing::PathStockBuilder * stockBuilder )

Sets the stock settings for stock assignment.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockBuilder stockbuilder

void NXOpen::Routing::StockBuilder::SetStockStyle ( NXOpen::Routing::StockBuilder::StockStyleType stockStyle )

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

License requirements : routing_base ("Routing Basic")

Parameters

stockStyle stockstyle

void NXOpen::Routing::StockBuilder::SetSwapProfile ( bool swapProfile )

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_base ("Routing Basic")

Parameters

swapProfile swapprofile

NXString NXOpen::Routing::StockBuilder::StockAnchor ( )

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

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::PathStockBuilder* NXOpen::Routing::StockBuilder::StockSettings ( )

Returns the stock settings for stock assignment.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::StockBuilder::StockStyleType NXOpen::Routing::StockBuilder::StockStyle ( )

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

License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::StockBuilder::SwapProfile ( )

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_base ("Routing Basic")

The documentation for this class was generated from the following file:

Routing_StockBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation