|
NXOpen C++ Reference Guide
|
|
NXOpen C++ Reference Guide
|
Represents the NX Manager session
To obtain an instance of this class, refer to NXOpen::Session
Created in NX7.5.0.
More...
Represents the NX Manager session
To obtain an instance of this class, refer to NXOpen::Session
Created in NX7.5.0.
| NXOpen::PDM::AttributeGroupDescriptionCollection* NXOpen::PDM::PdmSession::AttributeGroupDescriptions | ( | ) |
Returns a collection of NXOpen::PDM::AttributeGroupDescription objects representing attribute group types.
The collection contains attribute group descriptions for NXOpen::PDM::IAttributeGroupOwner objects loaded within the NX session. Use the NXOpen::PDM::IAttributeGroupOwner::GetAttributeGroupDescriptions to get the specific attribute group descriptions for an attribute group owner.
Created in NX9.0.0.
| NXOpen::PDM::PartOperationCopyBuilder* NXOpen::PDM::PdmSession::CreateCopyOperationBuilder | ( | NXOpen::PDM::PartOperationBuilder::OperationType | operation | ) |
Returns a new NXOpen::PDM::PartOperationCopyBuilder object
Created in NX10.0.0.
License requirements : None
| operation | operation |
| NXOpen::PDM::PartOperationCreateBuilder* NXOpen::PDM::PdmSession::CreateCreateOperationBuilder | ( | NXOpen::PDM::PartOperationBuilder::OperationType | operation | ) |
Returns a new NXOpen::PDM::PartOperationCreateBuilder object
Created in NX10.0.0.
License requirements : None
| operation | operation |
| NXOpen::PDM::ExportWorksetForReferenceBuilder* NXOpen::PDM::PdmSession::CreateExportWorksetForReferenceBuilder | ( | NXOpen::BasePart * | workset | ) |
Creates a new NXOpen::PDM::ExportWorksetForReferenceBuilder object used for exporting workset outside Teamcenter for reference.
Created in NX11.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
| workset | workset assembly to export |
| NXOpen::PDM::ExternalFileReferenceListBuilder* NXOpen::PDM::PdmSession::CreateExternalFileReferenceListBuilder | ( | const std::vector< NXOpen::NXObject * > & | objects | ) |
Creates a new NXOpen::PDM::ExternalFileReferenceListBuilder object.
Created in NX1847.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
| objects | the array of objects |
| void NXOpen::PDM::PdmSession::CreateFolder | ( | const NXString & | newFolderName, |
| const NXString & | parentFolderName | ||
| ) |
Create folder in Teamcenter with newFolderName under parentFolderName.
Created in NX1847.0.0.
License requirements : None
| newFolderName | Name of new folder to be created |
| parentFolderName | Name of parent folder specified in form "user:[folder1:][folderN:]", if empty API will try to use default or root folder as parent |
| void NXOpen::PDM::PdmSession::CreateFolder | ( | const char * | newFolderName, |
| const char * | parentFolderName | ||
| ) |
Create folder in Teamcenter with newFolderName under parentFolderName.
Created in NX1847.0.0.
License requirements : None
| newFolderName | Name of new folder to be created |
| parentFolderName | Name of parent folder specified in form "user:[folder1:][folderN:]", if empty API will try to use default or root folder as parent |
| NXOpen::PDM::PartOperationImportBuilder* NXOpen::PDM::PdmSession::CreateImportOperationBuilder | ( | ) |
Returns a new NXOpen::PDM::PartOperationImportBuilder object
Created in NX10.0.0.
License requirements : None
| NXOpen::PDM::PartOperationMakeUniqueBuilder* NXOpen::PDM::PdmSession::CreateMakeUniqueOperationBuilder | ( | NXOpen::BasePart * | part | ) |
Returns a new NXOpen::PDM::PartOperationMakeUniqueBuilder object
Created in NX10.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
| part | part |
| NXOpen::PDM::ObjectCreateBuilder* NXOpen::PDM::PdmSession::CreateObjectCreateBuilder | ( | std::vector< NXString > & | tcTypes, |
| std::vector< NXString > & | baseTCTypes | ||
| ) |
Returns a new NXOpen::PDM::ObjectCreateBuilder object
Created in NX10.0.0.
License requirements : None
| tcTypes | tctypes |
| baseTCTypes | basetctypes |
| NXOpen::PDM::PartOperationBuilder* NXOpen::PDM::PdmSession::CreateOperationBuilder | ( | NXOpen::PDM::PartOperationBuilder::OperationType | operation | ) |
Returns a new NXOpen::PDM::PartOperationBuilder object
Use NXOpen::PDM::PdmSession::CreateCopyOperationBuilder instead
Created in NX9.0.0.
License requirements : None
| operation | operation |
| NXOpen::PDM::PartOperationAttributePropertiesBuilder* NXOpen::PDM::PdmSession::CreatePartOperationAttributePropertiesBuilder | ( | const std::vector< NXOpen::NXObject * > & | objects | ) |
Creates a new NXOpen::PDM::PartOperationAttributePropertiesBuilder object.
Created in NX10.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
| objects | the array of objects |
| NXOpen::AttributePropertiesBuilder* NXOpen::PDM::PdmSession::CreatePartOperationValidationPropertiesBuilder | ( | const std::vector< NXOpen::NXObject * > & | objects | ) |
Creates a new AttributePropertiesBuilder object.
Created in NX10.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
| objects | the array of objects |
| NXOpen::PDM::SmartSaveBuilder* NXOpen::PDM::PdmSession::CreateSmartSaveBuilder | ( | NXOpen::PDM::SmartSaveBuilder::SaveType | saveType | ) |
Creates a new SmartSaveBuilder object.
Created in NX11.0.0.
License requirements : None
| saveType | savetype |
| NXOpen::PDM::SmartSaveBuilder* NXOpen::PDM::PdmSession::CreateSmartSaveBuilderWithContext | ( | NXOpen::PDM::SmartSaveContext * | smartSaveContext | ) |
Creates a new SmartSaveBuilder object.
Created in NX11.0.1.
License requirements : None
| smartSaveContext | smartsavecontext |
| NXOpen::PDM::SmartSaveContext* NXOpen::PDM::PdmSession::CreateSmartSaveContext | ( | NXOpen::PDM::SmartSaveBuilder::SaveType | saveType | ) |
Creates a new SmartSaveContext object.
Created in NX11.0.1.
License requirements : None
| saveType | savetype |
| void NXOpen::PDM::PdmSession::GetCheckedoutStatusOfAllObjectsInSession | ( | std::vector< NXOpen::NXObject * > & | checkedOutObjects, |
| std::vector< NXOpen::NXObject * > & | uncheckedOutObjects | ||
| ) |
Returns the checkedout status (checkedout/non checkedout) of all the objects open in NX.
Created in NX12.0.2.
License requirements : None
| checkedOutObjects | Array of NXObjects which are open in session and checked out |
| uncheckedOutObjects | Array of NXObjects which are open in session but not checkout |
| NXOpen::PDM::DatabaseObjectManager* NXOpen::PDM::PdmSession::GetDatabaseObjectManager | ( | ) |
Gets the NXOpen::PDM::DatabaseObjectManager object.
Created in NX11.0.0.
License requirements : None
| std::vector<NXString> NXOpen::PDM::PdmSession::GetItemTypes | ( | ) |
Returns array of all available Teamcenter Item Types.
Created in NX1847.0.0.
License requirements : None
| NXOpen::PDM::SoaConnectionHandle* NXOpen::PDM::PdmSession::GetSoaConnectionHandle | ( | ) |
Exposes the SOA Connection object that NX uses when running in Teamcenter Integration mode.
Returns a NXOpen::PDM::SoaConnectionHandle pointer. The application must obtain the handle from the pointer and reinterpret_cast it to Teamcenter::Soa::Client::Connection* pointer before use.
| void NXOpen::PDM::PdmSession::GetSsoSettings | ( | bool * | isSsoEnabled, |
| NXString * | ssoServerUrl, | ||
| NXString * | ssoAppID | ||
| ) |
Returns the SSO credentials, if SSO is available The client applications can use these settings to connect to the same Tcserver that NX is using.
Created in NX10.0.0.
License requirements : None
| isSsoEnabled | if SSO is enabled |
| ssoServerUrl | the SSO server URL |
| ssoAppID | the SSO app id |
| void NXOpen::PDM::PdmSession::GetTcserverSettings | ( | NXString * | connectString, |
| NXString * | discriminator | ||
| ) |
Returns the connect string and discriminator used by NX session to connect to the Tcserver.
The client applications can use these settings to connect to the same Tcserver that NX is using.
Tcserver connect string: The connect string is path of the server hosting the services. The connect string for the different transport protocols will be in the following form: 4-Tier(HTTP mode): similar to http: 2-Tier(IIOP mode): The Tcserver IOR string
Discriminator: The discriminator is a unique identifier and contains unique information related to a given TC server. This unique identifier (discriminator) is recognized by TC pool manager as the session number that ties the server process to the client. The discriminator functionality is part of the SOA package. The discriminator allows multiple clients to connect to the same TC server. In 2-Tier(IIOP mode), the discriminator will be an empty string.
To connect to the same Tcserver as NX, the client can create a Teamcenter::Soa::Client::Connection object using the connect string and then use the Teamcenter::Services::Core::SessionService to login to Teamcenter Server with the discriminator and the connection object. More information about connecting to the Teamcenter server can be found in the TC SOA API Documentation.
Created in NX7.5.0.
License requirements : None
| connectString | the connection string |
| discriminator | the discriminator |
| NXString NXOpen::PDM::PdmSession::GetUserGroup | ( | ) |
Gets the Teamcenter user group for the current user.
Created in NX1847.0.0.
License requirements : None
| NXString NXOpen::PDM::PdmSession::GetUserName | ( | ) |
Gets the Teamcenter user name for the current user.
Created in NX1847.0.0.
License requirements : None
| NXString NXOpen::PDM::PdmSession::GetUserRole | ( | ) |
Gets the Teamcenter role for the current user.
Created in NX1847.0.0.
License requirements : None
| NXOpen::PDM::CAEFileContainer* NXOpen::PDM::PdmSession::NewCaeFileContainer | ( | ) |
Returns a new NXOpen::PDM::CAEFileContainer object
Created in NX8.5.0.
License requirements : None
| NXOpen::PDM::FileManagement* NXOpen::PDM::PdmSession::NewFileManagement | ( | ) |
Returns a new NXOpen::PDM::FileManagement object
Created in NX7.5.4.
License requirements : None
| NXOpen::PDM::PartOperationImportObserver* NXOpen::PDM::PdmSession::PartOperationImportObserver | ( | ) |
Returns the NXOpen::PDM::PartOperationImportObserver belonging to this session
Created in NX10.0.0.
| NXOpen::PDM::SaveAsReviseObserver* NXOpen::PDM::PdmSession::SaveAsReviseObserver | ( | ) |
Returns the NXOpen::PDM::SaveAsReviseObserver belonging to this session
Created in NX11.0.0.
| NXOpen::PDM::SaveManagement::SaveObserver* NXOpen::PDM::PdmSession::SaveObserver | ( | ) |
Returns the NXOpen::PDM::SaveManagement::SaveObserver belonging to this session
Created in NX12.0.1.
| void NXOpen::PDM::PdmSession::SetActiveEngineeringChangeNotice | ( | NXOpen::NXObject * | part, |
| const NXString & | ecnMFKId, | ||
| const NXString & | ecnRevsionId | ||
| ) |
Sets active Engineering Change Notice (ECN) for the session.
All objects created will be added to solution items of this Engineering Change Notice. The input will be in the format of Change Notice MFK ID and Change Notice Revision ID. Note: Please make sure to set it at the start of the NXOpen program, before object creation.
Created in NX12.0.1.
License requirements : None
| part | tag of the displayed part, can be null |
| ecnMFKId | Change Notice MFKID to be set, can not be empty |
| ecnRevsionId | Change Notice Revision ID to be set, can not be empty |
| void NXOpen::PDM::PdmSession::SetActiveEngineeringChangeNotice | ( | NXOpen::NXObject * | part, |
| const char * | ecnMFKId, | ||
| const char * | ecnRevsionId | ||
| ) |
Sets active Engineering Change Notice (ECN) for the session.
All objects created will be added to solution items of this Engineering Change Notice. The input will be in the format of Change Notice MFK ID and Change Notice Revision ID. Note: Please make sure to set it at the start of the NXOpen program, before object creation.
Created in NX12.0.1.
License requirements : None
| part | tag of the displayed part, can be null |
| ecnMFKId | Change Notice MFKID to be set, can not be empty |
| ecnRevsionId | Change Notice Revision ID to be set, can not be empty |
| void NXOpen::PDM::PdmSession::SetDefaultFolder | ( | const NXString & | defaultFolderSpec | ) |
Sets default folder.
The input default folder path in format <username>:<folder>:<folder>, where username is optional. In that case, in :<folder>:<folder>, the first : indicates Home, for example, :Newstuff, is the Newstuff folder in current user's Home container
Created in NX7.5.0.
License requirements : None
| defaultFolderSpec | Default folder path including default folder name to be set |
| void NXOpen::PDM::PdmSession::SetDefaultFolder | ( | const char * | defaultFolderSpec | ) |
Sets default folder.
The input default folder path in format <username>:<folder>:<folder>, where username is optional. In that case, in :<folder>:<folder>, the first : indicates Home, for example, :Newstuff, is the Newstuff folder in current user's Home container
Created in NX7.5.0.
License requirements : None
| defaultFolderSpec | Default folder path including default folder name to be set |
| void NXOpen::PDM::PdmSession::SetNativeMode | ( | bool | enable, |
| bool | rereadTemplateInformation | ||
| ) |
Sets or unsets native mode for the session based on the value of input.
Created in NX12.0.1.
License requirements : None
| enable | flag to specify whether to set or unset native mode |
| rereadTemplateInformation | flag to specify whether to re-initialize managed templates |
| tag_t NXOpen::PDM::PdmSession::Tag | ( | ) | const |
Returns the tag of this object.
| NXOpen::PDM::TcinUtils* NXOpen::PDM::PdmSession::TcinUtils | ( | ) |
Returns the NXOpen::PDM::TcinUtils instance belonging to this session
Created in NX11.0.1.
