Assigns stocks to segments based on user's criteria and the current default stock. More...

Inheritance diagram for NXOpen.MechanicalRouting.PathStockPreferenceBuilder:

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

enum	AssignStockSubType { Stock, SpaceReservation }
	Determines the type of sub stock being assigned. More...

enum	AssignMethod { None, FromStartObject, Circular, Rectangular, FlatOval, SpecifiedStock }
	Determines how to choose which stock to assign. More...

enum	StockMethod { None, SpecifiedStock }
	Determines how to choose which stock to assign. More...

enum	SpaceReservationMethod { None, FromStartObject, Circular, Rectangular, FlatOval, SpecifiedSpaceReservation }
	Determines how to choose which space reservation to assign. More...

Public Member Functions
unsafe void	SetClassificationObjectIdentifier (string classificationObjectId)
	Sets the identifier of the classification object associated with the part to place More...

unsafe string	GetClassificationObjectIdentifierForStock ()
	Get the identifier of the classification object associated with the stock part to place NOTE: Client should NOT free the returned string More...

unsafe void	SetClassificationObjectIdentifierForStock (string classificationObjectId)
	Sets the identifier of the classification object associated with the stock part to place More...

unsafe string	GetFileSpecificationOfStockToPlace ()
	Get the file specification of the stock part to place NOTE: Client should NOT free the returned string More...

unsafe void	SetFileSpecificationOfStockToPlace (string filename)
	Sets the file specification of the stock part to place More...

unsafe string	GetClassificationObjectIdentifierForSpaceReservation ()
	Get the identifier of the classification object associated with the space reservation part to place NOTE: Client should NOT free the returned string More...

unsafe void	SetClassificationObjectIdentifierForSpaceReservation (string classificationObjectId)
	Sets the identifier of the classification object associated with the space reservation part to place More...

unsafe string	GetFileSpecificationOfSpaceReservationToPlace ()
	Get the file specification of the space reservation part to place NOTE: Client should NOT free the returned string More...

unsafe void	SetFileSpecificationOfSpaceReservationToPlace (string filename)
	Sets the file specification of the space reservation part to place More...

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

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

unsafe NXOpen.Expression	Diameter `[get, set]`
	Returns or sets the diameter value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.Circular method of stock assignment. More...

unsafe NXOpen.Expression	FlatOvalHeight `[get]`
	Returns the height value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.FlatOval method of stock assignment. More...

unsafe NXOpen.Expression	FlatOvalWidth `[get]`
	Returns the Width value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.FlatOval method of stock assignment More...

unsafe NXOpen.Expression	RectangularHeight `[get]`
	Returns the height value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.Rectangular method of stock assignment. More...

unsafe NXOpen.Expression	RectangularWidth `[get]`
	Returns the Width value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.Rectangular method of stock assignment More...

unsafe NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod	SpaceReservationMethodType `[get, set]`
	Returns or sets the method to determine which space reservation to assign. More...

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

unsafe NXOpen.MechanicalRouting.PathStockPreferenceBuilder.StockMethod	StockMethodType `[get, set]`
	Returns or sets the method to determine which stock to assign. More...

unsafe NXOpen.MechanicalRouting.PathStockPreferenceBuilder.AssignStockSubType	StockSubType `[get, set]`
	Returns or sets the type of stock being assigned. More...

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

Detailed Description

Assigns stocks to segments based on user's criteria and the current default stock.

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.MechanicalRouting.PathStockPreferenceBuilder.AssignMethod

Determines how to choose which stock to assign.

Enumerator
None	No Stock.
FromStartObject	Finds a stock based off of the default stock and the object selected by the user.
Circular	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

enum NXOpen.MechanicalRouting.PathStockPreferenceBuilder.AssignStockSubType

Determines the type of sub stock being assigned.

This is only valid when Stock type is 'Stock'

Enumerator
Stock	Default stock subtype.
SpaceReservation	Space Reservation stock subtype.

enum NXOpen.MechanicalRouting.PathStockPreferenceBuilder.AssignStockType

Determines the type of stock being assigned.

Enumerator
Stock	Default stock type.
Overstock	Overstock stock type.

enum NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod

Determines how to choose which space reservation to assign.

Enumerator
None	No Stock.
FromStartObject	Finds a stock based off of the default stock and the object selected by the user.
Circular	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.
SpecifiedSpaceReservation	sp selected from Specify Item dialog

enum NXOpen.MechanicalRouting.PathStockPreferenceBuilder.StockMethod

Determines how to choose which stock to assign.

Enumerator
None	No Stock.
SpecifiedStock	Stock selected from Specify Item dialog

Member Function Documentation

unsafe string NXOpen.MechanicalRouting.PathStockPreferenceBuilder.GetClassificationObjectIdentifierForSpaceReservation ( )

Get the identifier of the classification object associated with the space reservation part to place NOTE: Client should NOT free the returned string

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe string NXOpen.MechanicalRouting.PathStockPreferenceBuilder.GetClassificationObjectIdentifierForStock ( )

Get the identifier of the classification object associated with the stock part to place NOTE: Client should NOT free the returned string

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Returns

unsafe string NXOpen.MechanicalRouting.PathStockPreferenceBuilder.GetFileSpecificationOfSpaceReservationToPlace ( )

Get the file specification of the space reservation part to place NOTE: Client should NOT free the returned string

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Returns

unsafe string NXOpen.MechanicalRouting.PathStockPreferenceBuilder.GetFileSpecificationOfStockToPlace ( )

Get the file specification of the stock part to place NOTE: Client should NOT free the returned string

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe void NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SetClassificationObjectIdentifier ( string classificationObjectId )

Sets the identifier of the classification object associated with the part to place

Created in NX11.0.0

Deprecated in NX11.0.1. Use NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SetClassificationObjectIdentifierForStock instead.

License requirements: routing_base ("Routing Basic")

Parameters

classificationObjectId

unsafe void NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SetClassificationObjectIdentifierForSpaceReservation ( string classificationObjectId )

Sets the identifier of the classification object associated with the space reservation part to place

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

classificationObjectId

unsafe void NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SetClassificationObjectIdentifierForStock ( string classificationObjectId )

Sets the identifier of the classification object associated with the stock part to place

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Parameters

classificationObjectId

unsafe void NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SetFileSpecificationOfSpaceReservationToPlace ( string filename )

Sets the file specification of the space reservation part to place

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Parameters

filename

unsafe void NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SetFileSpecificationOfStockToPlace ( string filename )

Sets the file specification of the stock part to place

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

filename

unsafe bool NXOpen.MechanicalRouting.PathStockPreferenceBuilder.Validate ( )

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns: Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.MechanicalRouting.PathStockPreferenceBuilder.AssignMethod NXOpen.MechanicalRouting.PathStockPreferenceBuilder.AssignStockMethod

getset

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

Created in NX11.0.0

Deprecated in NX11.0.1. Use NXOpen.MechanicalRouting.PathStockPreferenceBuilder.StockMethodType instead.

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

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

unsafe NXOpen.Expression NXOpen.MechanicalRouting.PathStockPreferenceBuilder.Diameter

getset

Returns or sets the diameter value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.Circular method of stock assignment.

Created in NX11.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.MechanicalRouting.PathStockPreferenceBuilder.FlatOvalHeight

get

Returns the height value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.FlatOval method of stock assignment.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.MechanicalRouting.PathStockPreferenceBuilder.FlatOvalWidth

get

Returns the Width value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.FlatOval method of stock assignment

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.MechanicalRouting.PathStockPreferenceBuilder.RectangularHeight

get

Returns the height value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.Rectangular method of stock assignment.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.MechanicalRouting.PathStockPreferenceBuilder.RectangularWidth

get

Returns the Width value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.Rectangular method of stock assignment

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethodType

getset

Returns or sets the method to determine which space reservation to assign.

Created in NX11.0.1

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

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

unsafe NXOpen.NXObject NXOpen.MechanicalRouting.PathStockPreferenceBuilder.StartObject

getset

Returns or sets the start object to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SpaceReservationMethod.FromStartObject method of stock assignment.

Created in NX11.0.0

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

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

unsafe NXOpen.MechanicalRouting.PathStockPreferenceBuilder.StockMethod NXOpen.MechanicalRouting.PathStockPreferenceBuilder.StockMethodType

getset

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

Created in NX11.0.1

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

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

unsafe NXOpen.MechanicalRouting.PathStockPreferenceBuilder.AssignStockSubType NXOpen.MechanicalRouting.PathStockPreferenceBuilder.StockSubType

getset

Returns or sets the type of stock being assigned.

Created in NX11.0.0

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

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

unsafe NXOpen.MechanicalRouting.PathStockPreferenceBuilder.AssignStockType NXOpen.MechanicalRouting.PathStockPreferenceBuilder.StockType

getset

Returns or sets the type of stock being assigned.

Created in NX11.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:

dotnet_pool/MechanicalRouting_PathStockPreferenceBuilder.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation