NXOpen::Routing::PathStockBuilder Class Reference

Assigns stocks to segments based of users critiera and the current default stock. More...

Inheritance diagram for NXOpen::Routing::PathStockBuilder:

Public Types
enum	AssignMethod {   AssignMethodNone, AssignMethodDefaultStock, AssignMethodFromStartObject, AssignMethodDiameterValue,   AssignMethodRectangular, AssignMethodFlatOval, AssignMethodSpecifiedStock, AssignMethodFromParts }
	Determines how to choose which stock to assign. More...
enum	AssignStockType { AssignStockTypeStock, AssignStockTypeOverstock, AssignStockTypeFiller, AssignStockTypeSpaceReservation }
	Determines the type of stock being assigned. More...

Public Member Functions
void	AssignStock (const std::vector< NXOpen::Routing::ISegment * > &segments)
	Assigns stock using the method defined by this stock builder object.
NXOpen::Routing::PathStockBuilder::AssignMethod	AssignStockMethod ()
	Returns the method to determine which stock to assign.
double	DiameterValue ()
	Returns the diameter value to use for the Routing::PathStockBuilder::AssignMethodDiameterValue method of stock assignment.
NXOpen::Expression *	FlatOvalHeight ()
	Returns the height value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment.
NXOpen::Expression *	FlatOvalRotation ()
	Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment Created in NX7.5.0.
NXOpen::Expression *	FlatOvalWidth ()
	Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment Created in NX7.5.0.
void	GetFlatOvalDimensions (double *height, double *width)
	Get the FlatOval height and width value to use for the FlatOval space reservation assignment Created in NX8.0.0.
std::vector < NXOpen::Assemblies::Component * >	GetParts ()
	Get the parts to use for the Routing::PathStockBuilder::AssignMethodFromParts method of stock assignment.
void	GetRectangularDimensions (double *height, double *width)
	Get the rectangular height and width value to use for the rectangular space reservation assignment Created in NX8.0.0.
NXOpen::Routing::CharacteristicList *	GetSpecifiedStock ()
	Returns the specified stock to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.
void	GetSpecifiedStock (NXOpen::Routing::CharacteristicList **stockPart, NXOpen::Routing::CharacteristicList **appliedCharx)
	Returns the specified stock and applied characteristics to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.
NXOpen::Expression *	RectangularHeight ()
	Returns the height value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment.
NXOpen::Expression *	RectangularRotation ()
	Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment Created in NX7.5.0.
NXOpen::Expression *	RectangularWidth ()
	Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment Created in NX7.5.0.
void	SetAssignStockMethod (NXOpen::Routing::PathStockBuilder::AssignMethod method)
	Sets the method to determine which stock to assign.
void	SetDiameterValue (double val)
	Sets the diameter value to use for the Routing::PathStockBuilder::AssignMethodDiameterValue method of stock assignment.
void	SetFlatOvalDimensions (double height, double width)
	Set the FlatOval height and width value for the FlatOval space reservation assignment Created in NX8.0.0.
void	SetParts (const std::vector< NXOpen::Assemblies::Component * > &parts)
	Set the parts to use for the Routing::PathStockBuilder::AssignMethodFromParts method of stock assignment Created in NX7.5.0.
void	SetRectangularDimensions (double height, double width)
	Set the rectangular height and width value for the rectangular space reservation assignment Created in NX8.0.0.
void	SetSelectedStock (NXOpen::Routing::Stock *stock)
	Set the selected stock Created in NX8.0.0.
void	SetSpecifiedStock (NXOpen::Routing::CharacteristicList *stockPart)
	Sets the specified stock to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.
void	SetSpecifiedStock (NXOpen::Routing::CharacteristicList *stockPart, NXOpen::Routing::CharacteristicList *appliedCharx)
	Sets the specified stock and applied characteristics to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.
void	SetStartObject (NXOpen::NXObject *startObject)
	Sets the start object to use for the Routing::PathStockBuilder::AssignMethodFromStartObject method of stock assignment.
void	SetStockType (NXOpen::Routing::PathStockBuilder::AssignStockType stockType)
	Sets the type of stock being assigned.
void	SettingsChanged ()
	Notify the builder that the Routing preferred stock has been modified.
NXOpen::NXObject *	StartObject ()
	Returns the start object to use for the Routing::PathStockBuilder::AssignMethodFromStartObject method of stock assignment.
NXOpen::Routing::PathStockBuilder::AssignStockType	StockType ()
	Returns the type of stock being assigned.
void	UpdateExistingStock (NXOpen::Routing::Stock *existingStock)
	Updates an existing routing stock with settings stored in the builder.
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

Assigns stocks to segments based of users critiera and the current default stock.

To create a new instance of this class, use Routing::RouteManager::CreatePathStockBuilder

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Routing::PathStockBuilder::AssignMethod

Determines how to choose which stock to assign.

Enumerator:

AssignMethodNone	No Stock.
AssignMethodDefaultStock	Default Stock.
AssignMethodFromStartObject	Finds a stock based off of the default stock and the object selected by the user.
AssignMethodDiameterValue	User specified diameter, creates round space reservation stock.
AssignMethodRectangular	User specified values, creates rectangular space reservation stock.
AssignMethodFlatOval	User specified values, creates flat_oval space reservation stock.
AssignMethodSpecifiedStock	Stock selected from Specify Item dialog.
AssignMethodFromParts	Find stocks from the part table of parts selected by the user.

enum NXOpen::Routing::PathStockBuilder::AssignStockType

Determines the type of stock being assigned.

Enumerator:

AssignStockTypeStock	Default stock type.
AssignStockTypeOverstock	Overstock stock type.
AssignStockTypeFiller	Filler stock type.
AssignStockTypeSpaceReservation	Space Reservation stock type.

Member Function Documentation

void NXOpen::Routing::PathStockBuilder::AssignStock

(

const std::vector< NXOpen::Routing::ISegment * > &

segments

)

Assigns stock using the method defined by this stock builder object.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

segments

segments

NXOpen::Routing::PathStockBuilder::AssignMethod NXOpen::Routing::PathStockBuilder::AssignStockMethod

(

)

Returns the method to determine which stock to assign.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

double NXOpen::Routing::PathStockBuilder::DiameterValue

(

)

Returns the diameter value to use for the Routing::PathStockBuilder::AssignMethodDiameterValue method of stock assignment.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::PathStockBuilder::FlatOvalHeight

(

)

Returns the height value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment.

Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::PathStockBuilder::FlatOvalRotation

(

)

Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment
Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::PathStockBuilder::FlatOvalWidth

(

)

Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment
Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PathStockBuilder::GetFlatOvalDimensions	(	double *	height,
		double *	width
	)

Get the FlatOval height and width value to use for the FlatOval space reservation assignment
Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

height	height
width	width

std::vector<NXOpen::Assemblies::Component *> NXOpen::Routing::PathStockBuilder::GetParts

(

)

Get the parts to use for the Routing::PathStockBuilder::AssignMethodFromParts method of stock assignment.

Returns

Part table parts to get stock characteristics.
Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PathStockBuilder::GetRectangularDimensions	(	double *	height,
		double *	width
	)

Get the rectangular height and width value to use for the rectangular space reservation assignment
Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

height	height
width	width

NXOpen::Routing::CharacteristicList* NXOpen::Routing::PathStockBuilder::GetSpecifiedStock

(

)

Returns the specified stock to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.

Returns

Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PathStockBuilder::GetSpecifiedStock	(	NXOpen::Routing::CharacteristicList **	stockPart,
		NXOpen::Routing::CharacteristicList **	appliedCharx
	)

Returns the specified stock and applied characteristics to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.

Created in NX6.0.4.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart	Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
appliedCharx	Applied characteristics for the specified stock.

NXOpen::Expression* NXOpen::Routing::PathStockBuilder::RectangularHeight

(

)

Returns the height value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment.

Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::PathStockBuilder::RectangularRotation

(

)

Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment
Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::PathStockBuilder::RectangularWidth

(

)

Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment
Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PathStockBuilder::SetAssignStockMethod

(

NXOpen::Routing::PathStockBuilder::AssignMethod

method

)

Sets the method to determine which stock to assign.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

method

method

void NXOpen::Routing::PathStockBuilder::SetDiameterValue

(

double

val

)

Sets the diameter value to use for the Routing::PathStockBuilder::AssignMethodDiameterValue method of stock assignment.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

val

val

void NXOpen::Routing::PathStockBuilder::SetFlatOvalDimensions	(	double	height,
		double	width
	)

Set the FlatOval height and width value for the FlatOval space reservation assignment
Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

height	height
width	width

void NXOpen::Routing::PathStockBuilder::SetParts

(

const std::vector< NXOpen::Assemblies::Component * > &

parts

)

Set the parts to use for the Routing::PathStockBuilder::AssignMethodFromParts method of stock assignment
Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

Parameters

parts

Part table parts to get stock characteristics.

void NXOpen::Routing::PathStockBuilder::SetRectangularDimensions	(	double	height,
		double	width
	)

Set the rectangular height and width value for the rectangular space reservation assignment
Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

height	height
width	width

void NXOpen::Routing::PathStockBuilder::SetSelectedStock

(

NXOpen::Routing::Stock *

stock

)

Set the selected stock
Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stock

Selected Stock

void NXOpen::Routing::PathStockBuilder::SetSpecifiedStock

(

NXOpen::Routing::CharacteristicList *

stockPart

)

Sets the specified stock to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart

Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .

void NXOpen::Routing::PathStockBuilder::SetSpecifiedStock	(	NXOpen::Routing::CharacteristicList *	stockPart,
		NXOpen::Routing::CharacteristicList *	appliedCharx
	)

Sets the specified stock and applied characteristics to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.

Created in NX6.0.4.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart	Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
appliedCharx	Applied characteristics for the specified stock.

void NXOpen::Routing::PathStockBuilder::SetStartObject

(

NXOpen::NXObject *

startObject

)

Sets the start object to use for the Routing::PathStockBuilder::AssignMethodFromStartObject method of stock assignment.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

startObject

start object

void NXOpen::Routing::PathStockBuilder::SetStockType

(

NXOpen::Routing::PathStockBuilder::AssignStockType

stockType

)

Sets the type of stock being assigned.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockType

stock type

void NXOpen::Routing::PathStockBuilder::SettingsChanged

(

)

Notify the builder that the Routing preferred stock has been modified.

This updates the builder so that it now uses the new preferred stock do determine which stock to assign.
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::NXObject* NXOpen::Routing::PathStockBuilder::StartObject

(

)

Returns the start object to use for the Routing::PathStockBuilder::AssignMethodFromStartObject method of stock assignment.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::PathStockBuilder::AssignStockType NXOpen::Routing::PathStockBuilder::StockType

(

)

Returns the type of stock being assigned.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PathStockBuilder::UpdateExistingStock

(

NXOpen::Routing::Stock *

existingStock

)

Updates an existing routing stock with settings stored in the builder.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

existingStock

Existing Stock

---

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

• Routing_PathStockBuilder.hxx