RoutingStock Class¶
-
class
NXOpen.Preferences.
RoutingStock
¶ Bases:
object
The Preferences for Routing Stock objects.
These correspond to the values represented on the Preferences->Routing dialog, Stock property page. To obtain an instance of this class, refer to
NXOpen.Preferences.RoutingApplicationView
New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
CurrentTile | Returns or sets the current routing level/tile |
DefaultStockStyle | Returns or sets the default stock style |
DeleteOverstock | Returns or sets the delete overstock flag during deletion of last stock covered by the overstock |
SpaceReservationMode | Returns or sets the space reservation creation mode |
SpaceReservationTranslucency | Returns or sets the desired translucnecy of the newly created Space Reservation Stock |
StockAnchor | Returns or sets the NXOpen.Routing.Anchor name associated with the stock preferences. |
StockFolder | Returns or sets the default folder for stock components |
StockMode | Returns or sets the stock creation mode |
Methods¶
Method | Description |
---|---|
GetDefaultStock | Returns the current default stock to assign when creating paths. |
GetPreferredFillerStock | Returns the preferred for creating filler stock. |
GetPreferredOverstock | Returns the preferred stock for creating overstock. |
GetPreferredSpaceReservation | Returns the preferred stock for creating space reservation |
SetDefaultStock | Sets the current default stock to assign when creating paths. |
SetPreferredFillerStock | Sets the preferred stock for creating filler stock |
SetPreferredOverstock | Sets the preferred stock for creating overstock |
SetPreferredSpaceReservation | Sets the preferred stock for creating space Reservation |
Enumerations¶
RoutingStockSpaceReservationModeFlag Enumeration | Describes the valid value for space reservation mode. |
RoutingStockStockModeFlag Enumeration | Describes the valid value for stock mode. |
Property Detail¶
CurrentTile¶
-
RoutingStock.
CurrentTile
¶ Returns or sets the current routing level/tile
-------------------------------------
Getter Method
Signature
CurrentTile
Returns: Return type: str New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
CurrentTile
Parameters: tile (str) – New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
DefaultStockStyle¶
-
RoutingStock.
DefaultStockStyle
¶ Returns or sets the default stock style
-------------------------------------
Getter Method
Signature
DefaultStockStyle
Returns: Return type: NXOpen.Routing.StockStyle
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
DefaultStockStyle
Parameters: defaultStockStyle ( NXOpen.Routing.StockStyle
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
DeleteOverstock¶
-
RoutingStock.
DeleteOverstock
¶ Returns or sets the delete overstock flag during deletion of last stock covered by the overstock
-------------------------------------
Getter Method
Signature
DeleteOverstock
Returns: Return type: bool New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
DeleteOverstock
Parameters: deleteOverstock (bool) – New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SpaceReservationMode¶
-
RoutingStock.
SpaceReservationMode
¶ Returns or sets the space reservation creation mode
-------------------------------------
Getter Method
Signature
SpaceReservationMode
Returns: Return type: NXOpen.Preferences.RoutingStockSpaceReservationModeFlag
New in version NX7.5.2.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
SpaceReservationMode
Parameters: spaceReservationMode ( NXOpen.Preferences.RoutingStockSpaceReservationModeFlag
) –New in version NX7.5.2.
License requirements: routing_base (“Routing Basic”)
SpaceReservationTranslucency¶
-
RoutingStock.
SpaceReservationTranslucency
¶ Returns or sets the desired translucnecy of the newly created Space Reservation Stock
-------------------------------------
Getter Method
Signature
SpaceReservationTranslucency
Returns: Return type: int New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
SpaceReservationTranslucency
Parameters: spaceReservationTranslucency (int) – New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
StockAnchor¶
-
RoutingStock.
StockAnchor
¶ Returns or sets the
NXOpen.Routing.Anchor
name associated with the stock preferences.-------------------------------------
Getter Method
Signature
StockAnchor
Returns: Return type: str New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
StockAnchor
Parameters: anchorName (str) – New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
StockFolder¶
-
RoutingStock.
StockFolder
¶ Returns or sets the default folder for stock components
-------------------------------------
Getter Method
Signature
StockFolder
Returns: Return type: str New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
StockFolder
Parameters: stockFolder (str) – New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
StockMode¶
-
RoutingStock.
StockMode
¶ Returns or sets the stock creation mode
-------------------------------------
Getter Method
Signature
StockMode
Returns: Return type: NXOpen.Preferences.RoutingStockStockModeFlag
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
StockMode
Parameters: stockMode ( NXOpen.Preferences.RoutingStockStockModeFlag
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
GetDefaultStock¶
-
RoutingStock.
GetDefaultStock
¶ Returns the current default stock to assign when creating paths.
Signature
GetDefaultStock()
Returns: a tuple Return type: A tuple consisting of (stockPart, dataCharx). stockPart is a NXOpen.Routing.CharacteristicList
. Characteristic list used to find the appropriateNXOpen.Routing.StockData
for building the stock. SeeRouting.StockDataCollection.CreateStockData()
. dataCharx is aNXOpen.Routing.CharacteristicList
. The list of optional and required characteristics to apply to the new stock.New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetPreferredFillerStock¶
-
RoutingStock.
GetPreferredFillerStock
¶ Returns the preferred for creating filler stock.
Signature
GetPreferredFillerStock()
Returns: a tuple Return type: A tuple consisting of (stockPart, dataCharx). stockPart is a NXOpen.Routing.CharacteristicList
. Characteristic list used to find the appropriateNXOpen.Routing.StockData
for building the stock. SeeRouting.StockDataCollection.CreateStockData()
. dataCharx is aNXOpen.Routing.CharacteristicList
. The list of optional and required characteristics to apply to the new stock.New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
GetPreferredOverstock¶
-
RoutingStock.
GetPreferredOverstock
¶ Returns the preferred stock for creating overstock.
Signature
GetPreferredOverstock()
Returns: a tuple Return type: A tuple consisting of (stockPart, dataCharx). stockPart is a NXOpen.Routing.CharacteristicList
. Characteristic list used to find the appropriateNXOpen.Routing.StockData
for building the stock. SeeRouting.StockDataCollection.CreateStockData()
. dataCharx is aNXOpen.Routing.CharacteristicList
. The list of optional and required characteristics to apply to the new stock.New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
GetPreferredSpaceReservation¶
-
RoutingStock.
GetPreferredSpaceReservation
¶ Returns the preferred stock for creating space reservation
Signature
GetPreferredSpaceReservation()
Returns: a tuple Return type: A tuple consisting of (stockPart, dataCharx). stockPart is a NXOpen.Routing.CharacteristicList
. Characteristic list used to find the appropriateNXOpen.Routing.StockData
for building the stock. SeeRouting.StockDataCollection.CreateStockData()
. dataCharx is aNXOpen.Routing.CharacteristicList
. The list of optional and required characteristics to apply to the new stock.New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
SetDefaultStock¶
-
RoutingStock.
SetDefaultStock
¶ Sets the current default stock to assign when creating paths.
Signature
SetDefaultStock(stockPart, dataCharx)
Parameters: - stockPart (
NXOpen.Routing.CharacteristicList
) – Characteristic list used to find the appropriateNXOpen.Routing.StockData
for building the stock. SeeRouting.StockDataCollection.CreateStockData()
. - dataCharx (
NXOpen.Routing.CharacteristicList
) – The list of optional and required characteristics to apply to the new stock.
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
- stockPart (
SetPreferredFillerStock¶
-
RoutingStock.
SetPreferredFillerStock
¶ Sets the preferred stock for creating filler stock
Signature
SetPreferredFillerStock(stockPart, dataCharx)
Parameters: - stockPart (
NXOpen.Routing.CharacteristicList
) – Characteristic list used to find the appropriateNXOpen.Routing.StockData
for building the stock. SeeRouting.StockDataCollection.CreateStockData()
. - dataCharx (
NXOpen.Routing.CharacteristicList
) – The list of optional and required characteristics to apply to the new stock.
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
- stockPart (
SetPreferredOverstock¶
-
RoutingStock.
SetPreferredOverstock
¶ Sets the preferred stock for creating overstock
Signature
SetPreferredOverstock(stockPart, dataCharx)
Parameters: - stockPart (
NXOpen.Routing.CharacteristicList
) – Characteristic list used to find the appropriateNXOpen.Routing.StockData
for building the stock. SeeRouting.StockDataCollection.CreateStockData()
. - dataCharx (
NXOpen.Routing.CharacteristicList
) – The list of optional and required characteristics to apply to the new stock.
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
- stockPart (
SetPreferredSpaceReservation¶
-
RoutingStock.
SetPreferredSpaceReservation
¶ Sets the preferred stock for creating space Reservation
Signature
SetPreferredSpaceReservation(stockPart, dataCharx)
Parameters: - stockPart (
NXOpen.Routing.CharacteristicList
) – Characteristic list used to find the appropriateNXOpen.Routing.StockData
for building the stock. SeeRouting.StockDataCollection.CreateStockData()
. - dataCharx (
NXOpen.Routing.CharacteristicList
) – The list of optional and required characteristics to apply to the new stock.
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
- stockPart (