StockDataRefreshBuilder Class¶
-
class
NXOpen.Routing.StockDataRefreshBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Routing.StockDataRefreshBuilderBuilder for updating/reloading routing stock data definitions.To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreateStockDataRefreshBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| Status | Returns |
| StockData | Returns or sets |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| 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. |
| RefreshStockData | Update the Stock Data Definition Requires an update to be applied after call. |
| 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¶
| StockDataRefreshBuilderRefreshStatus Enumeration | The stock data refresh status |
Property Detail¶
Status¶
-
StockDataRefreshBuilder.Status¶ Returns
-------------------------------------Getter Method
Signature
StatusReturns: Return type: NXOpen.Routing.StockDataRefreshBuilderRefreshStatusNew in version NX12.0.0.
License requirements: routing_base (“Routing Basic”)
StockData¶
-
StockDataRefreshBuilder.StockData¶ Returns or sets
-------------------------------------Getter Method
Signature
StockDataReturns: Return type: NXOpen.Routing.StockDataNew in version NX12.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
StockDataParameters: stockData ( NXOpen.Routing.StockData) –New in version NX12.0.0.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
RefreshStockData¶
-
StockDataRefreshBuilder.RefreshStockData¶ Update the Stock Data Definition Requires an update to be applied after call.
Signature
RefreshStockData(stockData)Parameters: stockData ( NXOpen.Routing.StockData) –Returns: Return type: NXOpen.Routing.StockDataRefreshBuilderRefreshStatusNew in version NX12.0.0.
License requirements: routing_base (“Routing Basic”)
Validate¶
-
StockDataRefreshBuilder.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.