PathStockPreferenceBuilder Class

class NXOpen.MechanicalRouting.PathStockPreferenceBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

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

New in version NX11.0.0.

Properties

Property	Description
AssignStockMethod	Returns or sets the method to determine which stock to assign.
Diameter	Returns or sets the diameter value to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod.Circular method of stock assignment.
FlatOvalHeight	Returns the height value to use for the :py:class:` NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod.FlatOval < NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod>` method of stock assignment.
FlatOvalWidth	Returns the Width value to use for the :py:class:` NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod.FlatOval < NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod>` method of stock assignment
RectangularHeight	Returns the height value to use for the :py:class:` NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod.Rectangular < NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod>` method of stock assignment.
RectangularWidth	Returns the Width value to use for the :py:class:` NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod.Rectangular < NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod>` method of stock assignment
SpaceReservationMethodType	Returns or sets the method to determine which space reservation to assign.
StartObject	Returns or sets the start object to use for the NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod.FromStartObject method of stock assignment.
StockMethodType	Returns or sets the method to determine which stock to assign.
StockSubType	Returns or sets the type of stock being assigned.
StockType	Returns or sets the type of stock being assigned.
Tag	Returns the Tag for this object.

Methods

Method	Description
GetClassificationObjectIdentifierForSpaceReservation	Get the identifier of the classification object associated with the space reservation part to place NOTE: Client should NOT free the returned string
GetClassificationObjectIdentifierForStock	Get the identifier of the classification object associated with the stock part to place NOTE: Client should NOT free the returned string
GetFileSpecificationOfSpaceReservationToPlace	Get the file specification of the space reservation part to place NOTE: Client should NOT free the returned string
GetFileSpecificationOfStockToPlace	Get the file specification of the stock part to place NOTE: Client should NOT free the returned string
SetClassificationObjectIdentifier	Sets the identifier of the classification object associated with the part to place
SetClassificationObjectIdentifierForSpaceReservation	Sets the identifier of the classification object associated with the space reservation part to place
SetClassificationObjectIdentifierForStock	Sets the identifier of the classification object associated with the stock part to place
SetFileSpecificationOfSpaceReservationToPlace	Sets the file specification of the space reservation part to place
SetFileSpecificationOfStockToPlace	Sets the file specification of the stock part to place
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

PathStockPreferenceBuilderAssignMethod Enumeration	Determines how to choose which stock to assign.
PathStockPreferenceBuilderAssignStockSubType Enumeration	Determines the type of sub stock being assigned.
PathStockPreferenceBuilderAssignStockType Enumeration	Determines the type of stock being assigned.
PathStockPreferenceBuilderSpaceReservationMethod Enumeration	Determines how to choose which space reservation to assign.
PathStockPreferenceBuilderStockMethod Enumeration	Determines how to choose which stock to assign.

Property Detail

AssignStockMethod

PathStockPreferenceBuilder.AssignStockMethod

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

-------------------------------------

Getter Method

Signature AssignStockMethod

Returns: Return type:NXOpen.MechanicalRouting.PathStockPreferenceBuilderAssignMethod

New in version NX11.0.0.

Deprecated since version NX11.0.1: Use NXOpen.MechanicalRouting.PathStockPreferenceBuilder.StockMethodType() instead.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature AssignStockMethod

Parameters:method (NXOpen.MechanicalRouting.PathStockPreferenceBuilderAssignMethod) –

New in version NX11.0.0.

Deprecated since version NX11.0.1: Use NXOpen.MechanicalRouting.PathStockPreferenceBuilder.StockMethodType() instead.

License requirements: routing_base (“Routing Basic”)

Diameter

PathStockPreferenceBuilder.Diameter

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

-------------------------------------

Getter Method

Signature Diameter

Returns: Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature Diameter

Parameters:diameter (NXOpen.Expression) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

FlatOvalHeight

PathStockPreferenceBuilder.FlatOvalHeight

Returns the height value to use for the :py:class:` NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod.FlatOval < NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod>` method of stock assignment.

-------------------------------------

Getter Method

Signature FlatOvalHeight

Returns: Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

FlatOvalWidth

PathStockPreferenceBuilder.FlatOvalWidth

Returns the Width value to use for the :py:class:` NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod.FlatOval < NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod>` method of stock assignment

-------------------------------------

Getter Method

Signature FlatOvalWidth

Returns: Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

RectangularHeight

PathStockPreferenceBuilder.RectangularHeight

Returns the height value to use for the :py:class:` NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod.Rectangular < NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod>` method of stock assignment.

-------------------------------------

Getter Method

Signature RectangularHeight

Returns: Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

RectangularWidth

PathStockPreferenceBuilder.RectangularWidth

Returns the Width value to use for the :py:class:` NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod.Rectangular < NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod>` method of stock assignment

-------------------------------------

Getter Method

Signature RectangularWidth

Returns: Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

SpaceReservationMethodType

PathStockPreferenceBuilder.SpaceReservationMethodType

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

-------------------------------------

Getter Method

Signature SpaceReservationMethodType

Returns: Return type:NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature SpaceReservationMethodType

Parameters:method (NXOpen.MechanicalRouting.PathStockPreferenceBuilderSpaceReservationMethod) –

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

StartObject

PathStockPreferenceBuilder.StartObject

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

-------------------------------------

Getter Method

Signature StartObject

Returns: Return type:NXOpen.NXObject

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature StartObject

Parameters:startObject (NXOpen.NXObject) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

StockMethodType

PathStockPreferenceBuilder.StockMethodType

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

-------------------------------------

Getter Method

Signature StockMethodType

Returns: Return type:NXOpen.MechanicalRouting.PathStockPreferenceBuilderStockMethod

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature StockMethodType

Parameters:method (NXOpen.MechanicalRouting.PathStockPreferenceBuilderStockMethod) –

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

StockSubType

PathStockPreferenceBuilder.StockSubType

Returns or sets the type of stock being assigned.

-------------------------------------

Getter Method

Signature StockSubType

Returns: Return type:NXOpen.MechanicalRouting.PathStockPreferenceBuilderAssignStockSubType

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature StockSubType

Parameters:stockType (NXOpen.MechanicalRouting.PathStockPreferenceBuilderAssignStockSubType) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

StockType

PathStockPreferenceBuilder.StockType

Returns or sets the type of stock being assigned.

-------------------------------------

Getter Method

Signature StockType

Returns: Return type:NXOpen.MechanicalRouting.PathStockPreferenceBuilderAssignStockType

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature StockType

Parameters:stockType (NXOpen.MechanicalRouting.PathStockPreferenceBuilderAssignStockType) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

Method Detail

GetClassificationObjectIdentifierForSpaceReservation

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

Signature GetClassificationObjectIdentifierForSpaceReservation()

Returns: Return type:str

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

GetClassificationObjectIdentifierForStock

PathStockPreferenceBuilder.GetClassificationObjectIdentifierForStock

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

Signature GetClassificationObjectIdentifierForStock()

Returns: Return type:str

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

GetFileSpecificationOfSpaceReservationToPlace

PathStockPreferenceBuilder.GetFileSpecificationOfSpaceReservationToPlace

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

Signature GetFileSpecificationOfSpaceReservationToPlace()

Returns: Return type:str

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

GetFileSpecificationOfStockToPlace

PathStockPreferenceBuilder.GetFileSpecificationOfStockToPlace

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

Signature GetFileSpecificationOfStockToPlace()

Returns: Return type:str

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

SetClassificationObjectIdentifier

PathStockPreferenceBuilder.SetClassificationObjectIdentifier

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

Signature SetClassificationObjectIdentifier(classificationObjectId)

Parameters:classificationObjectId (str) –

New in version NX11.0.0.

Deprecated since version NX11.0.1: Use NXOpen.MechanicalRouting.PathStockPreferenceBuilder.SetClassificationObjectIdentifierForStock() instead.

License requirements: routing_base (“Routing Basic”)

SetClassificationObjectIdentifierForSpaceReservation

PathStockPreferenceBuilder.SetClassificationObjectIdentifierForSpaceReservation

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

Signature SetClassificationObjectIdentifierForSpaceReservation(classificationObjectId)

Parameters:classificationObjectId (str) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

SetClassificationObjectIdentifierForStock

PathStockPreferenceBuilder.SetClassificationObjectIdentifierForStock

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

Signature SetClassificationObjectIdentifierForStock(classificationObjectId)

Parameters:classificationObjectId (str) –

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

SetFileSpecificationOfSpaceReservationToPlace

PathStockPreferenceBuilder.SetFileSpecificationOfSpaceReservationToPlace

Sets the file specification of the space reservation part to place

Signature SetFileSpecificationOfSpaceReservationToPlace(filename)

Parameters:filename (str) –

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

SetFileSpecificationOfStockToPlace

PathStockPreferenceBuilder.SetFileSpecificationOfStockToPlace

Sets the file specification of the stock part to place

Signature SetFileSpecificationOfStockToPlace(filename)

Parameters:filename (str) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

Validate

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.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.