StockBrowserBuilder Class¶
-
class
NXOpen.Routing.
StockBrowserBuilder
¶ Bases:
NXOpen.Builder
Builder class for stock browser .
To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreateStockBrowserBuilder()
Default values.
Property Value FilterType All New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
FilterType | Returns or sets the stock type filter which defines the type of stock |
NameFilter | Returns or sets the stock name filter which defines filter to name stock |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
DeleteStocks | Deletes the given Routing.Stock or Routing.FittingOverstock |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
GetSortedList | Get the filtered stock object list |
SetSortedList | Set the filtered stock object list when filter type is changed. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
StockBrowserBuilderTypeFilter Enumeration | Filter type |
Property Detail¶
FilterType¶
-
StockBrowserBuilder.
FilterType
¶ Returns or sets the stock type filter which defines the type of stock
-------------------------------------
Getter Method
Signature
FilterType()
Returns: Return type: NXOpen.Routing.StockBrowserBuilderTypeFilter
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
FilterType(stockTypeFilter)
Parameters: stockTypeFilter ( NXOpen.Routing.StockBrowserBuilderTypeFilter
) –New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
NameFilter¶
-
StockBrowserBuilder.
NameFilter
¶ Returns or sets the stock name filter which defines filter to name stock
-------------------------------------
Getter Method
Signature
NameFilter()
Returns: Return type: str New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
NameFilter(stockNameFilter)
Parameters: stockNameFilter (str) – New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
DeleteStocks¶
-
StockBrowserBuilder.
DeleteStocks
¶ Deletes the given
Routing.Stock
orRouting.FittingOverstock
Signature
DeleteStocks(objects)
Parameters: objects (list of NXOpen.NXObject
) – Filtered Routing StocksNew in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
GetSortedList¶
-
StockBrowserBuilder.
GetSortedList
¶ Get the filtered stock object list
Signature
GetSortedList()
Returns: Filtered Routing Stocks Return type: list of NXOpen.NXObject
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
SetSortedList¶
-
StockBrowserBuilder.
SetSortedList
¶ Set the filtered stock object list when filter type is changed.
Signature
SetSortedList(objects)
Parameters: objects (list of NXOpen.NXObject
) – Filtered Routing StocksNew in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
Validate¶
-
StockBrowserBuilder.
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.