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

Inheritance diagram for NXOpen::MechanicalRouting::PathStockPreferenceBuilder:

Public Types
enum	AssignMethod { AssignMethodNone, AssignMethodFromStartObject, AssignMethodCircular, AssignMethodRectangular, AssignMethodFlatOval, AssignMethodSpecifiedStock }
	Determines how to choose which stock to assign. More...

enum	AssignStockSubType { AssignStockSubTypeStock, AssignStockSubTypeSpaceReservation }
	Determines the type of sub stock being assigned. More...

enum	AssignStockType { AssignStockTypeStock, AssignStockTypeOverstock }
	Determines the type of stock being assigned. More...

enum	SpaceReservationMethod { SpaceReservationMethodNone, SpaceReservationMethodFromStartObject, SpaceReservationMethodCircular, SpaceReservationMethodRectangular, SpaceReservationMethodFlatOval, SpaceReservationMethodSpecifiedSpaceReservation }
	Determines how to choose which space reservation to assign. More...

enum	StockMethod { StockMethodNone, StockMethodSpecifiedStock }
	Determines how to choose which stock to assign. More...

Public Member Functions
NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignMethod	AssignStockMethod ()
	Returns the method to determine which stock to assign. More...

NXOpen::Expression *	Diameter ()
	Returns the diameter value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodCircular method of stock assignment. More...

NXOpen::Expression *	FlatOvalHeight ()
	Returns the height value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodFlatOval method of stock assignment. More...

NXOpen::Expression *	FlatOvalWidth ()
	Returns the Width value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodFlatOval method of stock assignment Created in NX11.0.0. More...

NXString	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...

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

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

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

NXOpen::Expression *	RectangularHeight ()
	Returns the height value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodRectangular method of stock assignment. More...

NXOpen::Expression *	RectangularWidth ()
	Returns the Width value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodRectangular method of stock assignment Created in NX11.0.0. More...

void	SetAssignStockMethod (NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignMethod method)
	Sets the method to determine which stock to assign. More...

void	SetClassificationObjectIdentifier (const NXString &classificationObjectId)
	Sets the identifier of the classification object associated with the part to place More...

void	SetClassificationObjectIdentifier (const char *classificationObjectId)
	Sets the identifier of the classification object associated with the part to place More...

void	SetClassificationObjectIdentifierForSpaceReservation (const NXString &classificationObjectId)
	Sets the identifier of the classification object associated with the space reservation part to place Created in NX11.0.0. More...

void	SetClassificationObjectIdentifierForSpaceReservation (const char *classificationObjectId)
	Sets the identifier of the classification object associated with the space reservation part to place Created in NX11.0.0. More...

void	SetClassificationObjectIdentifierForStock (const NXString &classificationObjectId)
	Sets the identifier of the classification object associated with the stock part to place Created in NX11.0.1. More...

void	SetClassificationObjectIdentifierForStock (const char *classificationObjectId)
	Sets the identifier of the classification object associated with the stock part to place Created in NX11.0.1. More...

void	SetDiameter (NXOpen::Expression *diameter)
	Sets the diameter value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodCircular method of stock assignment. More...

void	SetFileSpecificationOfSpaceReservationToPlace (const NXString &filename)
	Sets the file specification of the space reservation part to place Created in NX11.0.1. More...

void	SetFileSpecificationOfSpaceReservationToPlace (const char *filename)
	Sets the file specification of the space reservation part to place Created in NX11.0.1. More...

void	SetFileSpecificationOfStockToPlace (const NXString &filename)
	Sets the file specification of the stock part to place Created in NX11.0.0. More...

void	SetFileSpecificationOfStockToPlace (const char *filename)
	Sets the file specification of the stock part to place Created in NX11.0.0. More...

void	SetSpaceReservationMethodType (NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethod method)
	Sets the method to determine which space reservation to assign. More...

void	SetStartObject (NXOpen::NXObject *startObject)
	Sets the start object to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodFromStartObject method of stock assignment. More...

void	SetStockMethodType (NXOpen::MechanicalRouting::PathStockPreferenceBuilder::StockMethod method)
	Sets the method to determine which stock to assign. More...

void	SetStockSubType (NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockSubType stockType)
	Sets the type of stock being assigned. More...

void	SetStockType (NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockType stockType)
	Sets the type of stock being assigned. More...

NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethod	SpaceReservationMethodType ()
	Returns the method to determine which space reservation to assign. More...

NXOpen::NXObject *	StartObject ()
	Returns the start object to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodFromStartObject method of stock assignment. More...

NXOpen::MechanicalRouting::PathStockPreferenceBuilder::StockMethod	StockMethodType ()
	Returns the method to determine which stock to assign. More...

NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockSubType	StockSubType ()
	Returns the type of stock being assigned. More...

NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockType	StockType ()
	Returns the type of stock being assigned. More...

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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.

Deprecated:: Deprecated in NX11.0.1. Use NXOpen::MechanicalRouting::PathStockPreferenceBuilder::StockMethod instead.

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

enum NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockSubType

Determines the type of sub stock being assigned.

This is only valid when Stock type is 'Stock'

Enumerator
AssignStockSubTypeStock	Default stock subtype.
AssignStockSubTypeSpaceReservation	Space Reservation stock subtype.

enum NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockType

Determines the type of stock being assigned.

Enumerator
AssignStockTypeStock	Default stock type.
AssignStockTypeOverstock	Overstock stock type.

enum NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethod

Determines how to choose which space reservation to assign.

Enumerator
SpaceReservationMethodNone	No Stock.
SpaceReservationMethodFromStartObject	Finds a stock based off of the default stock and the object selected by the user.
SpaceReservationMethodCircular	User specified diameter, creates round space reservation stock.
SpaceReservationMethodRectangular	User specified values, creates rectangular space reservation stock.
SpaceReservationMethodFlatOval	User specified values, creates flat_oval space reservation stock.
SpaceReservationMethodSpecifiedSpaceReservation	sp selected from Specify Item dialog

enum NXOpen::MechanicalRouting::PathStockPreferenceBuilder::StockMethod

Determines how to choose which stock to assign.

Enumerator
StockMethodNone	No Stock.
StockMethodSpecifiedStock	Stock selected from Specify Item dialog.

Member Function Documentation

NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignMethod NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockMethod ( )

Returns the method to determine which stock to assign.

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

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::MechanicalRouting::PathStockPreferenceBuilder::Diameter ( )

Returns the diameter value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodCircular method of stock assignment.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::MechanicalRouting::PathStockPreferenceBuilder::FlatOvalHeight ( )

Returns the height value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodFlatOval method of stock assignment.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::MechanicalRouting::PathStockPreferenceBuilder::FlatOvalWidth ( )

Returns the Width value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodFlatOval method of stock assignment
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXString 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.

Returns: Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXString 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.

Returns: Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

NXString NXOpen::MechanicalRouting::PathStockPreferenceBuilder::GetFileSpecificationOfSpaceReservationToPlace ( )

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

Returns: Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

NXString NXOpen::MechanicalRouting::PathStockPreferenceBuilder::GetFileSpecificationOfStockToPlace ( )

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

Returns: Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::MechanicalRouting::PathStockPreferenceBuilder::RectangularHeight ( )

Returns the height value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodRectangular method of stock assignment.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::MechanicalRouting::PathStockPreferenceBuilder::RectangularWidth ( )

Returns the Width value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodRectangular method of stock assignment
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetAssignStockMethod ( NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignMethod method )

Sets the method to determine which stock to assign.

Deprecated:: Deprecated in NX11.0.1. Use NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetStockMethodType instead.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

method method

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetClassificationObjectIdentifier ( const NXString & classificationObjectId )

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

Deprecated:: Deprecated in NX11.0.1.

Use NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetClassificationObjectIdentifierForStock instead.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

classificationObjectId classificationobjectid

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetClassificationObjectIdentifier ( const char * classificationObjectId )

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

Deprecated:: Deprecated in NX11.0.1.

Use NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetClassificationObjectIdentifierForStock instead.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

classificationObjectId classificationobjectid

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetClassificationObjectIdentifierForSpaceReservation ( const NXString & 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 classificationobjectid

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetClassificationObjectIdentifierForSpaceReservation ( const char * 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 classificationobjectid

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetClassificationObjectIdentifierForStock ( const NXString & 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 classificationobjectid

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetClassificationObjectIdentifierForStock ( const char * 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 classificationobjectid

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetDiameter ( NXOpen::Expression * diameter )

Sets the diameter value to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodCircular method of stock assignment.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

diameter diameter

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetFileSpecificationOfSpaceReservationToPlace ( const NXString & 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 filename

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetFileSpecificationOfSpaceReservationToPlace ( const char * 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 filename

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetFileSpecificationOfStockToPlace ( const NXString & filename )

Sets the file specification of the stock part to place
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

filename filename

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetFileSpecificationOfStockToPlace ( const char * filename )

Sets the file specification of the stock part to place
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

filename filename

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetSpaceReservationMethodType ( NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethod method )

Sets the method to determine which space reservation to assign.

Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

method method

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetStartObject ( NXOpen::NXObject * startObject )

Sets the start object to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodFromStartObject method of stock assignment.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

startObject start object

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetStockMethodType ( NXOpen::MechanicalRouting::PathStockPreferenceBuilder::StockMethod method )

Sets the method to determine which stock to assign.

Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

method method

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetStockSubType ( NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockSubType stockType )

Sets the type of stock being assigned.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockType stock type

void NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SetStockType ( NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockType stockType )

Sets the type of stock being assigned.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockType stock type

NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethod NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodType ( )

Returns the method to determine which space reservation to assign.

Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

NXOpen::NXObject* NXOpen::MechanicalRouting::PathStockPreferenceBuilder::StartObject ( )

Returns the start object to use for the NXOpen::MechanicalRouting::PathStockPreferenceBuilder::SpaceReservationMethodFromStartObject method of stock assignment.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::MechanicalRouting::PathStockPreferenceBuilder::StockMethod NXOpen::MechanicalRouting::PathStockPreferenceBuilder::StockMethodType ( )

Returns the method to determine which stock to assign.

Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockSubType NXOpen::MechanicalRouting::PathStockPreferenceBuilder::StockSubType ( )

Returns the type of stock being assigned.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::MechanicalRouting::PathStockPreferenceBuilder::AssignStockType NXOpen::MechanicalRouting::PathStockPreferenceBuilder::StockType ( )

Returns the type of stock being assigned.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

virtual bool NXOpen::MechanicalRouting::PathStockPreferenceBuilder::Validate ( )

virtual

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.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

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

MechanicalRouting_PathStockPreferenceBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation