NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder Class Reference

Builder which manages refreshing the runs from Teamcenter
To create a new instance of this class, use NXOpen::MechanicalRouting::BuilderFactory::CreateRefreshRunsFromTeamcenterBuilder

Created in NX1847.0.0. More...

Inheritance diagram for NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BlockedReasonType { BlockedReasonTypeNotBlocked, BlockedReasonTypeLoadedInPid, BlockedReasonTypeOtherRunsBlocked, BlockedReasonTypeNotSpecified }
 Defines the reason why the run refresh was blocked. More...
 
enum  RefreshStatusType {
  RefreshStatusTypeUnknown, RefreshStatusTypeUpToDate, RefreshStatusTypeRefreshed, RefreshStatusTypeBlocked,
  RefreshStatusTypeDeleted, RefreshStatusTypeFailed
}
 Defines the refresh status. More...
 

Public Member Functions

NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::BlockedReasonType GetBlockedReasonForRun (const NXString &runId)
 The blocked reason getter. More...
 
NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::BlockedReasonType GetBlockedReasonForRun (const char *runId)
 The blocked reason getter. More...
 
NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::RefreshStatusType GetRefreshStatusForRun (const NXString &runId)
 The refresh status getter. More...
 
NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::RefreshStatusType GetRefreshStatusForRun (const char *runId)
 The refresh status getter. More...
 
int GetTimestampOfRefreshedRun (const NXString &runId)
 The timestamp of the refreshed run getter. More...
 
int GetTimestampOfRefreshedRun (const char *runId)
 The timestamp of the refreshed run getter. 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

Builder which manages refreshing the runs from Teamcenter
To create a new instance of this class, use NXOpen::MechanicalRouting::BuilderFactory::CreateRefreshRunsFromTeamcenterBuilder

Created in NX1847.0.0.


Member Enumeration Documentation

Defines the reason why the run refresh was blocked.

Not blocked, loaded in PID application, not specified

Enumerator
BlockedReasonTypeNotBlocked 

Blocked reason is that it's not blocked.

BlockedReasonTypeLoadedInPid 

Blocked reason is that the PID run is currently loaded in the PID application.

BlockedReasonTypeOtherRunsBlocked 

Blocked reason is that one or more runs were blocked.

BlockedReasonTypeNotSpecified 

Blocked reason is not specified.

Defines the refresh status.

Unknown, up-to-date, refreshed, blocked, failed

Enumerator
RefreshStatusTypeUnknown 

The run is an unknown state.

RefreshStatusTypeUpToDate 

The run is up-to-date.

RefreshStatusTypeRefreshed 

The run was refreshed to a new version.

RefreshStatusTypeBlocked 

The refresh of the run was blocked.

RefreshStatusTypeDeleted 

The refresh of the run did not happen because the run was deleted in Teamcetner.

RefreshStatusTypeFailed 

The refresh of the run failed.

Member Function Documentation

NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::BlockedReasonType NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::GetBlockedReasonForRun ( const NXString runId)

The blocked reason getter.

Returns
The blocked reason for the run
Created in NX1847.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
runIdThe run to get the blocked reason for
NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::BlockedReasonType NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::GetBlockedReasonForRun ( const char *  runId)

The blocked reason getter.

Returns
The blocked reason for the run
Created in NX1847.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
runIdThe run to get the blocked reason for
NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::RefreshStatusType NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::GetRefreshStatusForRun ( const NXString runId)

The refresh status getter.

Returns
The refresh status for the run
Created in NX1847.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
runIdThe run to get the status for
NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::RefreshStatusType NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::GetRefreshStatusForRun ( const char *  runId)

The refresh status getter.

Returns
The refresh status for the run
Created in NX1847.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
runIdThe run to get the status for
int NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::GetTimestampOfRefreshedRun ( const NXString runId)

The timestamp of the refreshed run getter.

Returns
The timestamp of the refreshed run
Created in NX1847.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
runIdThe run to get the timestamp of the refreshed run for
int NXOpen::MechanicalRouting::RefreshRunsFromTeamcenterBuilder::GetTimestampOfRefreshedRun ( const char *  runId)

The timestamp of the refreshed run getter.

Returns
The timestamp of the refreshed run
Created in NX1847.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
runIdThe run to get the timestamp of the refreshed run for

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