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

Inheritance diagram for NXOpen.Routing.PathStockBuilder:

Public Types
enum	AssignMethod { None, DefaultStock, FromStartObject, DiameterValue, Rectangular, FlatOval, SpecifiedStock, FromParts }
	Determines how to choose which stock to assign. More...

enum	AssignStockType { Stock, Overstock, Filler, SpaceReservation }
	Determines the type of stock being assigned. More...

Public Member Functions
unsafe void	AssignStock (NXOpen.Routing.ISegment[] segments)
	Assigns stock using the method defined by this stock builder object. More...

unsafe bool	DefaultOrientationAlignmentEnabled ()
	Get the flag if non-circular stock default alignment is enabled More...

unsafe void	EnableDefaultOrientationAlignment (bool suggestRotationAngle)
	Set the flag if it is to enable non-circular stock default alignment or not More...

unsafe void	GetFlatOvalDimensions (out double height, out double width)
	Get the FlatOval height and width value to use for the FlatOval space reservation assignment More...

unsafe NXOpen.Assemblies.Component[]	GetParts ()
	Get the parts to use for the Routing.PathStockBuilder.AssignMethod.FromParts method of stock assignment More...

unsafe void	GetRectangularDimensions (out double height, out double width)
	Get the rectangular height and width value to use for the rectangular space reservation assignment More...

unsafe NXOpen.Routing.CharacteristicList	GetSpecifiedStock ()
	Returns the specified stock to use for the Routing.PathStockBuilder.AssignMethod.SpecifiedStock method of stock assignment. More...

unsafe void	GetSpecifiedStock (out NXOpen.Routing.CharacteristicList stockPart, out NXOpen.Routing.CharacteristicList appliedCharx)
	Returns the specified stock and applied characteristics to use for the Routing.PathStockBuilder.AssignMethod.SpecifiedStock method of stock assignment. More...

unsafe bool	IsRotationOverriden ()
	Get the rotation value overwritten flag More...

unsafe void	OverrideRotation (bool overrideRotation)
	Set the rotation value overwritten flag More...

unsafe void	SetFlatOvalDimensions (double height, double width)
	Set the FlatOval height and width value for the FlatOval space reservation assignment More...

unsafe void	SetParts (NXOpen.Assemblies.Component[] parts)
	Set the parts to use for the Routing.PathStockBuilder.AssignMethod.FromParts method of stock assignment More...

unsafe void	SetRectangularDimensions (double height, double width)
	Set the rectangular height and width value for the rectangular space reservation assignment More...

unsafe void	SetSelectedStock (NXOpen.Routing.Stock stock)
	Set the selected stock More...

unsafe void	SetSpecifiedStock (NXOpen.Routing.CharacteristicList stockPart)
	Sets the specified stock to use for the Routing.PathStockBuilder.AssignMethod.SpecifiedStock method of stock assignment. More...

unsafe void	SetSpecifiedStock (NXOpen.Routing.CharacteristicList stockPart, NXOpen.Routing.CharacteristicList appliedCharx)
	Sets the specified stock and applied characteristics to use for the Routing.PathStockBuilder.AssignMethod.SpecifiedStock method of stock assignment. More...

unsafe void	SettingsChanged ()
	Notify the builder that the Routing preferred stock has been modified. More...

unsafe void	UpdateExistingStock (NXOpen.Routing.Stock existingStock)
	Updates an existing routing stock with settings stored in the builder. More...

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

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

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

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

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Routing.PathStockBuilder.AssignMethod	AssignStockMethod `[get, set]`
	Returns or sets the method to determine which stock to assign. More...

unsafe double	DiameterValue `[get, set]`
	Returns or sets the diameter value to use for the Routing.PathStockBuilder.AssignMethod.DiameterValue method of stock assignment. More...

unsafe NXOpen.Expression	FlatOvalHeight `[get]`
	Returns the height value to use for the Routing.PathStockBuilder.AssignMethod.FlatOval method of stock assignment. More...

unsafe NXOpen.Expression	FlatOvalRotation `[get]`
	Returns the Width value to use for the Routing.PathStockBuilder.AssignMethod.FlatOval method of stock assignment More...

unsafe NXOpen.Expression	FlatOvalWidth `[get]`
	Returns the Width value to use for the Routing.PathStockBuilder.AssignMethod.FlatOval method of stock assignment More...

unsafe NXOpen.Expression	RectangularHeight `[get]`
	Returns the height value to use for the Routing.PathStockBuilder.AssignMethod.Rectangular method of stock assignment. More...

unsafe NXOpen.Expression	RectangularRotation `[get]`
	Returns the Width value to use for the Routing.PathStockBuilder.AssignMethod.Rectangular method of stock assignment More...

unsafe NXOpen.Expression	RectangularWidth `[get]`
	Returns the Width value to use for the Routing.PathStockBuilder.AssignMethod.Rectangular method of stock assignment More...

unsafe NXOpen.NXObject	StartObject `[get, set]`
	Returns or sets the start object to use for the Routing.PathStockBuilder.AssignMethod.FromStartObject method of stock assignment. More...

unsafe NXOpen.Expression	StockRotation `[get]`
	Returns the stock rotation value More...

unsafe NXOpen.Routing.PathStockBuilder.AssignStockType	StockType `[get, set]`
	Returns or sets the type of stock being assigned. More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

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

To create a new instance of this class, use NXOpen.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
None	No Stock.
DefaultStock	Default Stock.
FromStartObject	Finds a stock based off of the default stock and the object selected by the user.
DiameterValue	User specified diameter, creates round space reservation stock.
Rectangular	User specified values, creates rectangular space reservation stock.
FlatOval	User specified values, creates flat_oval space reservation stock.
SpecifiedStock	Stock selected from Specify Item dialog
FromParts	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
Stock	Default stock type.
Overstock	Overstock stock type.
Filler	Filler stock type.
SpaceReservation	Space Reservation stock type.

Member Function Documentation

unsafe void NXOpen.Routing.PathStockBuilder.AssignStock ( NXOpen.Routing.ISegment[] segments )

inline

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

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters

segments

unsafe bool NXOpen.Routing.PathStockBuilder.DefaultOrientationAlignmentEnabled ( )

inline

Get the flag if non-circular stock default alignment is enabled

Created in NX9.0.3

License requirements: routing_base ("Routing Basic")

Returns

unsafe void NXOpen.Routing.PathStockBuilder.EnableDefaultOrientationAlignment ( bool suggestRotationAngle )

inline

Set the flag if it is to enable non-circular stock default alignment or not

Created in NX9.0.3

License requirements: routing_base ("Routing Basic")

Parameters

suggestRotationAngle

unsafe void NXOpen.Routing.PathStockBuilder.GetFlatOvalDimensions	(	out double	height,
		out double	width
	)

inline

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
width

unsafe NXOpen.Assemblies.Component [] NXOpen.Routing.PathStockBuilder.GetParts ( )

inline

Get the parts to use for the Routing.PathStockBuilder.AssignMethod.FromParts method of stock assignment

Created in NX7.5.0

License requirements: routing_base ("Routing Basic")

Returns: Part table parts to get stock characteristics.

unsafe void NXOpen.Routing.PathStockBuilder.GetRectangularDimensions	(	out double	height,
		out double	width
	)

inline

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
width

unsafe NXOpen.Routing.CharacteristicList NXOpen.Routing.PathStockBuilder.GetSpecifiedStock ( )

inline

Returns the specified stock to use for the Routing.PathStockBuilder.AssignMethod.SpecifiedStock method of stock assignment.

Created in NX6.0.0

License requirements: routing_base ("Routing Basic")

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

unsafe void NXOpen.Routing.PathStockBuilder.GetSpecifiedStock	(	out NXOpen.Routing.CharacteristicList	stockPart,
		out NXOpen.Routing.CharacteristicList	appliedCharx
	)

inline

Returns the specified stock and applied characteristics to use for the Routing.PathStockBuilder.AssignMethod.SpecifiedStock 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.

unsafe bool NXOpen.Routing.PathStockBuilder.IsRotationOverriden ( )

inline

Get the rotation value overwritten flag

Created in NX9.0.3

License requirements: routing_base ("Routing Basic")

Returns

unsafe void NXOpen.Routing.PathStockBuilder.OverrideRotation ( bool overrideRotation )

inline

Set the rotation value overwritten flag

Created in NX9.0.3

License requirements: routing_base ("Routing Basic")

Parameters

overrideRotation

unsafe void NXOpen.Routing.PathStockBuilder.SetFlatOvalDimensions	(	double	height,
		double	width
	)

inline

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
width

unsafe void NXOpen.Routing.PathStockBuilder.SetParts ( NXOpen.Assemblies.Component[] parts )

inline

Set the parts to use for the Routing.PathStockBuilder.AssignMethod.FromParts method of stock assignment

Created in NX7.5.0

License requirements: routing_base ("Routing Basic")

Parameters

parts Part table parts to get stock characteristics.

unsafe void NXOpen.Routing.PathStockBuilder.SetRectangularDimensions	(	double	height,
		double	width
	)

inline

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
width

unsafe void NXOpen.Routing.PathStockBuilder.SetSelectedStock ( NXOpen.Routing.Stock stock )

inline

Set the selected stock

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Parameters

stock Selected Stock

unsafe void NXOpen.Routing.PathStockBuilder.SetSpecifiedStock ( NXOpen.Routing.CharacteristicList stockPart )

inline

Sets the specified stock to use for the Routing.PathStockBuilder.AssignMethod.SpecifiedStock 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 .

unsafe void NXOpen.Routing.PathStockBuilder.SetSpecifiedStock	(	NXOpen.Routing.CharacteristicList	stockPart,
		NXOpen.Routing.CharacteristicList	appliedCharx
	)

inline

Sets the specified stock and applied characteristics to use for the Routing.PathStockBuilder.AssignMethod.SpecifiedStock 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.

unsafe void NXOpen.Routing.PathStockBuilder.SettingsChanged ( )

inline

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")

unsafe void NXOpen.Routing.PathStockBuilder.UpdateExistingStock ( NXOpen.Routing.Stock existingStock )

inline

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

Property Documentation

unsafe NXOpen.Routing.PathStockBuilder.AssignMethod NXOpen.Routing.PathStockBuilder.AssignStockMethod

getset

Returns or sets the method to determine which stock to assign.

Created in NX5.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe double NXOpen.Routing.PathStockBuilder.DiameterValue

getset

Returns or sets the diameter value to use for the Routing.PathStockBuilder.AssignMethod.DiameterValue method of stock assignment.

Created in NX6.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.Routing.PathStockBuilder.FlatOvalHeight

get

Returns the height value to use for the Routing.PathStockBuilder.AssignMethod.FlatOval method of stock assignment.

Created in NX7.5.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.Routing.PathStockBuilder.FlatOvalRotation

get

Returns the Width value to use for the Routing.PathStockBuilder.AssignMethod.FlatOval method of stock assignment

Created in NX7.5.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.Routing.PathStockBuilder.FlatOvalWidth

get

Returns the Width value to use for the Routing.PathStockBuilder.AssignMethod.FlatOval method of stock assignment

Created in NX7.5.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.Routing.PathStockBuilder.RectangularHeight

get

Returns the height value to use for the Routing.PathStockBuilder.AssignMethod.Rectangular method of stock assignment.

Created in NX7.5.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.Routing.PathStockBuilder.RectangularRotation

get

Returns the Width value to use for the Routing.PathStockBuilder.AssignMethod.Rectangular method of stock assignment

Created in NX7.5.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.Routing.PathStockBuilder.RectangularWidth

get

Returns the Width value to use for the Routing.PathStockBuilder.AssignMethod.Rectangular method of stock assignment

Created in NX7.5.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.NXObject NXOpen.Routing.PathStockBuilder.StartObject

getset

Returns or sets the start object to use for the Routing.PathStockBuilder.AssignMethod.FromStartObject method of stock assignment.

Created in NX5.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.Routing.PathStockBuilder.StockRotation

get

Returns the stock rotation value

Created in NX12.0.2

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Routing.PathStockBuilder.AssignStockType NXOpen.Routing.PathStockBuilder.StockType

getset

Returns or sets the type of stock being assigned.

Created in NX6.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

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

Routing_PathStockBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation