NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Routing::StockDataRefreshBuilder Class Reference

Represents a NXOpen::Routing::StockDataRefreshBuilder Builder for updating/reloading routing stock data definitions. More...

Inheritance diagram for NXOpen::Routing::StockDataRefreshBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  RefreshStatus {
  RefreshStatusOk, RefreshStatusStockDataTagInvalid, RefreshStatusStockDataMissingSearchAttributes, RefreshStatusStockPartNotFoundInReuseLibrary,
  RefreshStatusMultipleStocksFoundInReuseLibrary, RefreshStatusStockPartNotRequired, RefreshStatusStockPartNotFoundForLoading, RefreshStatusCannotFullyLoadStockPart,
  RefreshStatusStockDataNotFoundInLoadedPart, RefreshStatusStockConversionError, RefreshStatusErrorRefreshUndone
}
 The stock data refresh status
Created in NX12.0.0. More...
 

Public Member Functions

NXOpen::Routing::StockDataRefreshBuilder::RefreshStatus RefreshStockData (NXOpen::Routing::StockData *stockData)
 Update the Stock Data Definition Requires an update to be applied after call. More...
 
void SetStockData (NXOpen::Routing::StockData *stockData)
 Sets
Created in NX12.0.0. More...
 
NXOpen::Routing::StockDataRefreshBuilder::RefreshStatus Status ()
 Returns
Created in NX12.0.0. More...
 
NXOpen::Routing::StockDataStockData ()
 Returns
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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

Represents a NXOpen::Routing::StockDataRefreshBuilder Builder for updating/reloading routing stock data definitions.


To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateStockDataRefreshBuilder

Created in NX12.0.0.

Member Enumeration Documentation

The stock data refresh status
Created in NX12.0.0.


Enumerator
RefreshStatusOk 

Refresh successful.

RefreshStatusStockDataTagInvalid 

NULL stock definition encountered.

RefreshStatusStockDataMissingSearchAttributes 

No attributes used for searching library found.

RefreshStatusStockPartNotFoundInReuseLibrary 

Cannot find stock under the stock or overstock root nodes in the Reuse Library.

RefreshStatusMultipleStocksFoundInReuseLibrary 

More than one stock found - cannot resolve ambiguity.

RefreshStatusStockPartNotRequired 

Stock part name not found indicating there is no stock part.

RefreshStatusStockPartNotFoundForLoading 

Problem loading the stock part.

RefreshStatusCannotFullyLoadStockPart 

Unable to fully load the stock part.

RefreshStatusStockDataNotFoundInLoadedPart 

Unable to find a stock definition in the loaded stock part.

RefreshStatusStockConversionError 

Error converting units of loaded stock part to that of stock definition being refreshed.

RefreshStatusErrorRefreshUndone 

Error encountered after partial update of stock definition; UNDO was performed to return to original state.

Member Function Documentation

NXOpen::Routing::StockDataRefreshBuilder::RefreshStatus NXOpen::Routing::StockDataRefreshBuilder::RefreshStockData ( NXOpen::Routing::StockData stockData)

Update the Stock Data Definition Requires an update to be applied after call.

Returns

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
stockDatastockdata
void NXOpen::Routing::StockDataRefreshBuilder::SetStockData ( NXOpen::Routing::StockData stockData)

Sets
Created in NX12.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
stockDatastockdata
NXOpen::Routing::StockDataRefreshBuilder::RefreshStatus NXOpen::Routing::StockDataRefreshBuilder::Status ( )

Returns
Created in NX12.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Routing::StockData* NXOpen::Routing::StockDataRefreshBuilder::StockData ( )

Returns
Created in NX12.0.0.



License requirements : routing_base ("Routing Basic")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.