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

Inheritance diagram for NXOpen.Routing.StockBlockBuilder:

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

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

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

enum	SpaceReservationSelectionSource { ClassficationObject, PTBLibrary, Session }
	Determines the source of space reservation to assign. More...

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

enum	StockSelectionSource { ClassficationObject, PTBLibrary, Database, Session }
	Determines the source of stock to assign. More...

Public Member Functions
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 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 string	GetFileSpecificationOfSpaceReservationToPlace ()
	Get the file specification of the space reservation part to place NOTE: Client should NOT free the returned string More...

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

unsafe NXOpen.Routing.AttributeHolder	GetLibraryDefinedAttributeHolderForSpaceReservation ()
	Gets the attribute holder for library defined attributes on space reservation to be applied More...

unsafe NXOpen.Routing.AttributeHolder	GetLibraryDefinedAttributeHolderForStock ()
	Gets the attribute holder for library defined attributes on stock to be applied More...

unsafe void	ResetAttributesOnLibraryDefinedAttributeHolder ()
	Resets the attribute holder for library defined attributes for stock and space reservation attribute holders This API is recommented to be used before assigning attributes onto builder so as to ensure stock/space reservation apply operation to function correctly More...

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

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

unsafe void	SetComponentSelectedInSession (NXOpen.Assemblies.Component component)
	Sets stock component selected in NX session while applying stock More...

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

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

unsafe void	SetPartNumberIdentifierForSpaceReservation (string partNumberId)
	Sets the part number identifier of the attributeHolder object associated with the stock part to create More...

unsafe void	SetPartNumberIdentifierForStock (string partNumberId)
	Sets the identifier of the attributeHolder object associated with the stock part to create More...

unsafe void	SetSpaceReservationSelectionSource (NXOpen.Routing.StockBlockBuilder.SpaceReservationSelectionSource stockSelectionSource)
	Sets the source of space reservation to assign More...

unsafe void	SetStockSelectionSource (NXOpen.Routing.StockBlockBuilder.StockSelectionSource stockSelectionSource)
	Sets the source of stock to assign 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.Expression	Diameter `[get, set]`
	Returns or sets the diameter value to use for the NXOpen.Routing.StockBlockBuilder.SpaceReservationMethod.Circular method of stock assignment. More...

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

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

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

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

unsafe NXOpen.Routing.StockBlockBuilder.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.Routing.StockBlockBuilder.SpaceReservationMethod.FromStartObject method of stock assignment. More...

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

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

unsafe NXOpen.Routing.StockBlockBuilder.AssignStockType	StockType `[get, set]`
	Returns or sets the type of stock being assigned. 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 on user's criteria and the current default stock.

Created in NX1847.0.0

Member Enumeration Documentation

enum NXOpen.Routing.StockBlockBuilder.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.Routing.StockBlockBuilder.AssignStockType

Determines the type of stock being assigned.

Enumerator
Stock	Default stock type.
Overstock	Overstock stock type.

enum NXOpen.Routing.StockBlockBuilder.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.Routing.StockBlockBuilder.SpaceReservationSelectionSource

Determines the source of space reservation to assign.

Enumerator
ClassficationObject	SpaceReservation selected from classification
PTBLibrary	SpaceReservation selected from part table library
Session	SpaceReservation selected from NX session

enum NXOpen.Routing.StockBlockBuilder.StockMethod

Determines how to choose which stock to assign.

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

enum NXOpen.Routing.StockBlockBuilder.StockSelectionSource

Determines the source of stock to assign.

Enumerator
ClassficationObject	Stock selected from classification
PTBLibrary	Stock selected from part table library
Database	stock selected from database or disk
Session	stock selected from NX session

Member Function Documentation

unsafe string NXOpen.Routing.StockBlockBuilder.GetClassificationObjectIdentifierForSpaceReservation ( )

inline

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 NX1847.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe string NXOpen.Routing.StockBlockBuilder.GetClassificationObjectIdentifierForStock ( )

inline

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

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe string NXOpen.Routing.StockBlockBuilder.GetFileSpecificationOfSpaceReservationToPlace ( )

inline

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

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe string NXOpen.Routing.StockBlockBuilder.GetFileSpecificationOfStockToPlace ( )

inline

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

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe NXOpen.Routing.AttributeHolder NXOpen.Routing.StockBlockBuilder.GetLibraryDefinedAttributeHolderForSpaceReservation ( )

inline

Gets the attribute holder for library defined attributes on space reservation to be applied

Created in NX1872.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe NXOpen.Routing.AttributeHolder NXOpen.Routing.StockBlockBuilder.GetLibraryDefinedAttributeHolderForStock ( )

inline

Gets the attribute holder for library defined attributes on stock to be applied

Created in NX1872.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe void NXOpen.Routing.StockBlockBuilder.ResetAttributesOnLibraryDefinedAttributeHolder ( )

inline

Resets the attribute holder for library defined attributes for stock and space reservation attribute holders This API is recommented to be used before assigning attributes onto builder so as to ensure stock/space reservation apply operation to function correctly

Created in NX1872.0.0

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.Routing.StockBlockBuilder.SetClassificationObjectIdentifierForSpaceReservation ( string classificationObjectId )

inline

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

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Parameters

classificationObjectId

unsafe void NXOpen.Routing.StockBlockBuilder.SetClassificationObjectIdentifierForStock ( string classificationObjectId )

inline

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

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Parameters

classificationObjectId

unsafe void NXOpen.Routing.StockBlockBuilder.SetComponentSelectedInSession ( NXOpen.Assemblies.Component component )

inline

Sets stock component selected in NX session while applying stock

Created in NX1899.0.0

License requirements: routing_base ("Routing Basic")

Parameters

component

unsafe void NXOpen.Routing.StockBlockBuilder.SetFileSpecificationOfSpaceReservationToPlace ( string filename )

inline

Sets the file specification of the space reservation part to place

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Parameters

filename

unsafe void NXOpen.Routing.StockBlockBuilder.SetFileSpecificationOfStockToPlace ( string filename )

inline

Sets the file specification of the stock part to place

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Parameters

filename

unsafe void NXOpen.Routing.StockBlockBuilder.SetPartNumberIdentifierForSpaceReservation ( string partNumberId )

inline

Sets the part number identifier of the attributeHolder object associated with the stock part to create

Created in NX1872.0.0

License requirements: routing_base ("Routing Basic")

Parameters

partNumberId

unsafe void NXOpen.Routing.StockBlockBuilder.SetPartNumberIdentifierForStock ( string partNumberId )

inline

Sets the identifier of the attributeHolder object associated with the stock part to create

Created in NX1872.0.0

License requirements: routing_base ("Routing Basic")

Parameters

partNumberId

unsafe void NXOpen.Routing.StockBlockBuilder.SetSpaceReservationSelectionSource ( NXOpen.Routing.StockBlockBuilder.SpaceReservationSelectionSource stockSelectionSource )

inline

Sets the source of space reservation to assign

Created in NX1872.0.0

License requirements: routing_base ("Routing Basic")

Parameters

stockSelectionSource

unsafe void NXOpen.Routing.StockBlockBuilder.SetStockSelectionSource ( NXOpen.Routing.StockBlockBuilder.StockSelectionSource stockSelectionSource )

inline

Sets the source of stock to assign

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

Parameters

stockSelectionSource

unsafe bool NXOpen.Routing.StockBlockBuilder.Validate ( )

inline

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.Expression NXOpen.Routing.StockBlockBuilder.Diameter

getset

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

Created in NX1847.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.StockBlockBuilder.FlatOvalHeight

get

Returns the height value to use for the NXOpen.Routing.StockBlockBuilder.SpaceReservationMethod.FlatOval method of stock assignment.

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.Routing.StockBlockBuilder.FlatOvalWidth

get

Returns the Width value to use for the NXOpen.Routing.StockBlockBuilder.SpaceReservationMethod.FlatOval method of stock assignment

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.Routing.StockBlockBuilder.RectangularHeight

get

Returns the height value to use for the NXOpen.Routing.StockBlockBuilder.SpaceReservationMethod.Rectangular method of stock assignment.

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Expression NXOpen.Routing.StockBlockBuilder.RectangularWidth

get

Returns the Width value to use for the NXOpen.Routing.StockBlockBuilder.SpaceReservationMethod.Rectangular method of stock assignment

Created in NX1847.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Routing.StockBlockBuilder.SpaceReservationMethod NXOpen.Routing.StockBlockBuilder.SpaceReservationMethodType

getset

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

Created in NX1847.0.0

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

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

unsafe NXOpen.NXObject NXOpen.Routing.StockBlockBuilder.StartObject

getset

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

Created in NX1847.0.0

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

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

unsafe NXOpen.Routing.StockBlockBuilder.StockMethod NXOpen.Routing.StockBlockBuilder.StockMethodType

getset

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

Created in NX1847.0.0

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

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

unsafe NXOpen.Routing.StockBlockBuilder.AssignStockSubType NXOpen.Routing.StockBlockBuilder.StockSubType

getset

Returns or sets the type of stock being assigned.

Created in NX1847.0.0

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

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

unsafe NXOpen.Routing.StockBlockBuilder.AssignStockType NXOpen.Routing.StockBlockBuilder.StockType

getset

Returns or sets the type of stock being assigned.

Created in NX1847.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_StockBlockBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation