|
NX Open 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.
| operation | operation |
| NXOpen::PDM::PartOperationCreateBuilder* NXOpen::PDM::PdmSession::CreateCreateOperationBuilder | ( | NXOpen::PDM::PartOperationBuilder::OperationType | operation | ) |
Returns a new NXOpen::PDM::PartOperationCreateBuilder object.
| 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.
| workset | workset assembly to export |
| NXOpen::PDM::PartOperationImportBuilder* NXOpen::PDM::PdmSession::CreateImportOperationBuilder | ( | ) |
Returns a new NXOpen::PDM::PartOperationImportBuilder object.
| NXOpen::PDM::PartOperationMakeUniqueBuilder* NXOpen::PDM::PdmSession::CreateMakeUniqueOperationBuilder | ( | NXOpen::BasePart * | part | ) |
Returns a new NXOpen::PDM::PartOperationMakeUniqueBuilder object.
| part | part |
| NXOpen::PDM::ObjectCreateBuilder* NXOpen::PDM::PdmSession::CreateObjectCreateBuilder | ( | std::vector< NXString > & | tcTypes, |
| std::vector< NXString > & | baseTCTypes | ||
| ) |
Returns a new NXOpen::PDM::ObjectCreateBuilder object.
| tcTypes | tctypes |
| baseTCTypes | basetctypes |
| NXOpen::PDM::PartOperationBuilder* NXOpen::PDM::PdmSession::CreateOperationBuilder | ( | NXOpen::PDM::PartOperationBuilder::OperationType | operation | ) |
Returns a new NXOpen::PDM::PartOperationBuilder object.
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.
| objects | the array of objects |
| NXOpen::AttributePropertiesBuilder* NXOpen::PDM::PdmSession::CreatePartOperationValidationPropertiesBuilder | ( | const std::vector< NXOpen::NXObject * > & | objects | ) |
Creates a new AttributePropertiesBuilder object.
| 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.
| smartSaveContext | smartsavecontext |
| NXOpen::PDM::SmartSaveContext* NXOpen::PDM::PdmSession::CreateSmartSaveContext | ( | NXOpen::PDM::SmartSaveBuilder::SaveType | saveType | ) |
Creates a new SmartSaveContext object.
| saveType | savetype |
| NXOpen::PDM::DatabaseObjectManager* NXOpen::PDM::PdmSession::GetDatabaseObjectManager | ( | ) |
Gets the NXOpen::PDM::DatabaseObjectManager object.
| 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 |
| NXOpen::PDM::CAEFileContainer* NXOpen::PDM::PdmSession::NewCaeFileContainer | ( | ) |
Returns a new NXOpen::PDM::CAEFileContainer object.
| NXOpen::PDM::FileManagement* NXOpen::PDM::PdmSession::NewFileManagement | ( | ) |
Returns a new NXOpen::PDM::FileManagement object.
| 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.
| void NXOpen::PDM::PdmSession::SetActiveEngineeringChangeNotice | ( | NXOpen::Part * | part, |
| const NXString & | ecnId, | ||
| const NXString & | ecnRevsionId | ||
| ) |
Sets active ECN for the session.
The input will be in the format of ECN ID and the ECN Revision ID.
Created in NX12.0.0.
License requirements : None
| part | tag of the displayed part |
| ecnId | ECN ItemID to be set |
| ecnRevsionId | ECN ItemRevID to be set |
| void NXOpen::PDM::PdmSession::SetActiveEngineeringChangeNotice | ( | NXOpen::Part * | part, |
| const char * | ecnId, | ||
| const char * | ecnRevsionId | ||
| ) |
Sets active ECN for the session.
The input will be in the format of ECN ID and the ECN Revision ID.
Created in NX12.0.0.
License requirements : None
| part | tag of the displayed part |
| ecnId | ECN ItemID to be set |
| ecnRevsionId | ECN ItemRevID to be set |
| 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 |
| tag_t NXOpen::PDM::PdmSession::Tag | ( | ) | const |
Returns the tag of this object.