NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::PDM::PendingComponentsManager Class Reference

This class is used for managing a part's pending components, that is, those that have been added within Teamcenter but are not yet present in NX. More...

Inheritance diagram for NXOpen::PDM::PendingComponentsManager:
NXOpen::TransientObject

Public Member Functions

NXOpen::Assemblies::ComponentAddComponent (const NXString &handle, NXOpen::PartLoadStatus **loadStatus)
 Adds a pending component. More...
 
NXOpen::Assemblies::ComponentAddComponent (const char *handle, NXOpen::PartLoadStatus **loadStatus)
 Adds a pending component. More...
 
NXOpen::Assemblies::ComponentAddNgcComponent (const NXString &handle, NXOpen::PartLoadStatus **loadStatus)
 Adds a pending NGC component. More...
 
NXOpen::Assemblies::ComponentAddNgcComponent (const char *handle, NXOpen::PartLoadStatus **loadStatus)
 Adds a pending NGC component. More...
 
bool ComponentHasPosition (const NXString &handle)
 Determines whether a given pending component has been positioned by Teamcenter. More...
 
bool ComponentHasPosition (const char *handle)
 Determines whether a given pending component has been positioned by Teamcenter. More...
 
void DeleteComponent (const NXString &handle)
 Deletes a pending component. More...
 
void DeleteComponent (const char *handle)
 Deletes a pending component. More...
 
NXString GetComponentPartFileName (const NXString &handle)
 Gets the NX Manager file name for the part corresponding to a pending component. More...
 
NXString GetComponentPartFileName (const char *handle)
 Gets the NX Manager file name for the part corresponding to a pending component. More...
 
std::vector< NXStringGetComponents ()
 Gets "handles" for the pending components of the part associated with this object. More...
 
virtual ~PendingComponentsManager ()
 Free resources associated with the instance. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

This class is used for managing a part's pending components, that is, those that have been added within Teamcenter but are not yet present in NX.

An instance of this class for a particular part can be created by calling PDM::PartManager::NewPendingComponentsManager .


Created in NX4.0.1.

Constructor & Destructor Documentation

virtual NXOpen::PDM::PendingComponentsManager::~PendingComponentsManager ( )
virtual

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX4.0.1.

License requirements : None

Member Function Documentation

NXOpen::Assemblies::Component* NXOpen::PDM::PendingComponentsManager::AddComponent ( const NXString handle,
NXOpen::PartLoadStatus **  loadStatus 
)

Adds a pending component.

Returns

Created in NX4.0.1.

License requirements : None
Parameters
handlethe handle for the pending component
loadStatusresult of loading the component part
NXOpen::Assemblies::Component* NXOpen::PDM::PendingComponentsManager::AddComponent ( const char *  handle,
NXOpen::PartLoadStatus **  loadStatus 
)

Adds a pending component.

Returns

Created in NX4.0.1.

License requirements : None
Parameters
handlethe handle for the pending component
loadStatusresult of loading the component part
NXOpen::Assemblies::Component* NXOpen::PDM::PendingComponentsManager::AddNgcComponent ( const NXString handle,
NXOpen::PartLoadStatus **  loadStatus 
)

Adds a pending NGC component.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
handlethe handle for the pending ngc component
loadStatusresult of loading the ngc component part
NXOpen::Assemblies::Component* NXOpen::PDM::PendingComponentsManager::AddNgcComponent ( const char *  handle,
NXOpen::PartLoadStatus **  loadStatus 
)

Adds a pending NGC component.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
handlethe handle for the pending ngc component
loadStatusresult of loading the ngc component part
bool NXOpen::PDM::PendingComponentsManager::ComponentHasPosition ( const NXString handle)

Determines whether a given pending component has been positioned by Teamcenter.

If PDM::PendingComponentsManager::AddComponent is called regarding a component without a position, it will automatically be positioned at the origin.

Returns

Created in NX4.0.1.

License requirements : None
Parameters
handlethe handle for the pending component
bool NXOpen::PDM::PendingComponentsManager::ComponentHasPosition ( const char *  handle)

Determines whether a given pending component has been positioned by Teamcenter.

If PDM::PendingComponentsManager::AddComponent is called regarding a component without a position, it will automatically be positioned at the origin.

Returns

Created in NX4.0.1.

License requirements : None
Parameters
handlethe handle for the pending component
void NXOpen::PDM::PendingComponentsManager::DeleteComponent ( const NXString handle)

Deletes a pending component.


Created in NX4.0.1.

License requirements : None

Parameters
handlethe handle for the pending component
void NXOpen::PDM::PendingComponentsManager::DeleteComponent ( const char *  handle)

Deletes a pending component.


Created in NX4.0.1.

License requirements : None

Parameters
handlethe handle for the pending component
NXString NXOpen::PDM::PendingComponentsManager::GetComponentPartFileName ( const NXString handle)

Gets the NX Manager file name for the part corresponding to a pending component.

Returns

Created in NX4.0.1.

License requirements : None
Parameters
handlethe handle for the pending component
NXString NXOpen::PDM::PendingComponentsManager::GetComponentPartFileName ( const char *  handle)

Gets the NX Manager file name for the part corresponding to a pending component.

Returns

Created in NX4.0.1.

License requirements : None
Parameters
handlethe handle for the pending component
std::vector<NXString> NXOpen::PDM::PendingComponentsManager::GetComponents ( )

Gets "handles" for the pending components of the part associated with this object.

Returns

Created in NX4.0.1.

License requirements : None

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