NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.PDM.PdmSession Class Reference

Represents the NX Manager session More...

Inheritance diagram for NXOpen.PDM.PdmSession:

Public Member Functions

unsafe void GetTcserverSettings (out string connectString, out string discriminator)
 Returns the connect string and discriminator used by NX session to connect to the Tcserver. More...
 
unsafe void GetSsoSettings (out bool isSsoEnabled, out string ssoServerUrl, out string 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. More...
 
unsafe void SetDefaultFolder (string defaultFolderSpec)
 Sets default folder. More...
 
unsafe NXOpen.PDM.FileManagement NewFileManagement ()
 Returns a new NXOpen.PDM.FileManagement object More...
 
unsafe NXOpen.PDM.CAEFileContainer NewCaeFileContainer ()
 Returns a new NXOpen.PDM.CAEFileContainer object More...
 
unsafe
NXOpen.PDM.PartOperationCopyBuilder 
CreateCopyOperationBuilder (NXOpen.PDM.PartOperationBuilder.OperationType operation)
 Returns a new NXOpen.PDM.PartOperationCopyBuilder object More...
 
unsafe
NXOpen.PDM.PartOperationCreateBuilder 
CreateCreateOperationBuilder (NXOpen.PDM.PartOperationBuilder.OperationType operation)
 Returns a new NXOpen.PDM.PartOperationCreateBuilder object More...
 
unsafe
NXOpen.PDM.PartOperationBuilder 
CreateOperationBuilder (NXOpen.PDM.PartOperationBuilder.OperationType operation)
 Returns a new NXOpen.PDM.PartOperationBuilder object More...
 
unsafe
NXOpen.PDM.ObjectCreateBuilder 
CreateObjectCreateBuilder (string[] tcTypes, string[] baseTCTypes)
 Returns a new NXOpen.PDM.ObjectCreateBuilder object More...
 
unsafe
NXOpen.PDM.PartOperationMakeUniqueBuilder 
CreateMakeUniqueOperationBuilder (NXOpen.BasePart part)
 Returns a new NXOpen.PDM.PartOperationMakeUniqueBuilder object More...
 
unsafe
NXOpen.PDM.PartOperationImportBuilder 
CreateImportOperationBuilder ()
 Returns a new NXOpen.PDM.PartOperationImportBuilder object More...
 
unsafe
NXOpen.PDM.PartOperationAttributePropertiesBuilder 
CreatePartOperationAttributePropertiesBuilder (NXOpen.NXObject[] objects)
 Creates a new NXOpen.PDM.PartOperationAttributePropertiesBuilder object. More...
 
unsafe
NXOpen.AttributePropertiesBuilder 
CreatePartOperationValidationPropertiesBuilder (NXOpen.NXObject[] objects)
 Creates a new AttributePropertiesBuilder object. More...
 
unsafe
NXOpen.PDM.DatabaseObjectManager 
GetDatabaseObjectManager ()
 Gets the NXOpen.PDM.DatabaseObjectManager object. More...
 
unsafe NXOpen.PDM.SmartSaveBuilder CreateSmartSaveBuilder (NXOpen.PDM.SmartSaveBuilder.SaveType saveType)
 Creates a new SmartSaveBuilder object. More...
 
unsafe NXOpen.PDM.SmartSaveContext CreateSmartSaveContext (NXOpen.PDM.SmartSaveBuilder.SaveType saveType)
 Creates a new SmartSaveContext object. More...
 
unsafe NXOpen.PDM.SmartSaveBuilder CreateSmartSaveBuilderWithContext (NXOpen.PDM.SmartSaveContext smartSaveContext)
 Creates a new SmartSaveBuilder object. More...
 
unsafe
NXOpen.PDM.ExportWorksetForReferenceBuilder 
CreateExportWorksetForReferenceBuilder (NXOpen.BasePart workset)
 Creates a new NXOpen.PDM.ExportWorksetForReferenceBuilder object used for exporting workset outside Teamcenter for reference. More...
 
unsafe void SetActiveEngineeringChangeNotice (NXOpen.Part part, string ecnId, string ecnRevsionId)
 Sets active ECN for the session. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 
NXOpen.PDM.AttributeGroupDescriptionCollection AttributeGroupDescriptions [get]
 Returns a collection of NXOpen.PDM.AttributeGroupDescription objects representing attribute group types. More...
 
NXOpen.PDM.PartOperationImportObserver PartOperationImportObserver [get]
 Returns the NXOpen.PDM.PartOperationImportObserver belonging to this session More...
 
NXOpen.PDM.SaveAsReviseObserver SaveAsReviseObserver [get]
 Returns the NXOpen.PDM.SaveAsReviseObserver belonging to this session More...
 

Detailed Description

Represents the NX Manager session

To obtain an instance of this class, refer to NXOpen.Session

Created in NX7.5.0

Member Function Documentation

unsafe 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.

Parameters
operation
Returns
unsafe 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.

Parameters
operation
Returns
unsafe 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")

Parameters
worksetworkset assembly to export
Returns
unsafe NXOpen.PDM.PartOperationImportBuilder NXOpen.PDM.PdmSession.CreateImportOperationBuilder ( )

Returns a new NXOpen.PDM.PartOperationImportBuilder object

Created in NX10.0.0

License requirements: None.

Returns
unsafe 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")

Parameters
part
Returns
unsafe NXOpen.PDM.ObjectCreateBuilder NXOpen.PDM.PdmSession.CreateObjectCreateBuilder ( string[]  tcTypes,
string[]  baseTCTypes 
)

Returns a new NXOpen.PDM.ObjectCreateBuilder object

Created in NX10.0.0

License requirements: None.

Parameters
tcTypes
baseTCTypes
Returns
unsafe NXOpen.PDM.PartOperationBuilder NXOpen.PDM.PdmSession.CreateOperationBuilder ( NXOpen.PDM.PartOperationBuilder.OperationType  operation)

Returns a new NXOpen.PDM.PartOperationBuilder object

Created in NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PdmSession.CreateCopyOperationBuilder instead

License requirements: None.

Parameters
operation
Returns
unsafe NXOpen.PDM.PartOperationAttributePropertiesBuilder NXOpen.PDM.PdmSession.CreatePartOperationAttributePropertiesBuilder ( NXOpen.NXObject[]  objects)

Creates a new NXOpen.PDM.PartOperationAttributePropertiesBuilder object.

Created in NX10.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
objectsthe array of objects
Returns
unsafe NXOpen.AttributePropertiesBuilder NXOpen.PDM.PdmSession.CreatePartOperationValidationPropertiesBuilder ( NXOpen.NXObject[]  objects)

Creates a new AttributePropertiesBuilder object.

Created in NX10.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
objectsthe array of objects
Returns
unsafe NXOpen.PDM.SmartSaveBuilder NXOpen.PDM.PdmSession.CreateSmartSaveBuilder ( NXOpen.PDM.SmartSaveBuilder.SaveType  saveType)

Creates a new SmartSaveBuilder object.

Created in NX11.0.0

Deprecated in NX11.0.1. Use NXOpen.PDM.PdmSession.CreateSmartSaveBuilderWithContext instead

License requirements: None.

Parameters
saveType
Returns
unsafe NXOpen.PDM.SmartSaveBuilder NXOpen.PDM.PdmSession.CreateSmartSaveBuilderWithContext ( NXOpen.PDM.SmartSaveContext  smartSaveContext)

Creates a new SmartSaveBuilder object.

Created in NX11.0.1

License requirements: None.

Parameters
smartSaveContext
Returns
unsafe 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.

Parameters
saveType
Returns
unsafe NXOpen.PDM.DatabaseObjectManager NXOpen.PDM.PdmSession.GetDatabaseObjectManager ( )

Gets the NXOpen.PDM.DatabaseObjectManager object.

Created in NX11.0.0

License requirements: None.

Returns
unsafe void NXOpen.PDM.PdmSession.GetSsoSettings ( out bool  isSsoEnabled,
out string  ssoServerUrl,
out string  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.

Parameters
isSsoEnabledif SSO is enabled
ssoServerUrlthe SSO server URL
ssoAppIDthe SSO app id
unsafe void NXOpen.PDM.PdmSession.GetTcserverSettings ( out string  connectString,
out string  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.

Parameters
connectStringthe connection string
discriminatorthe discriminator
unsafe NXOpen.PDM.CAEFileContainer NXOpen.PDM.PdmSession.NewCaeFileContainer ( )

Returns a new NXOpen.PDM.CAEFileContainer object

Created in NX8.5.0

License requirements: None.

Returns
unsafe NXOpen.PDM.FileManagement NXOpen.PDM.PdmSession.NewFileManagement ( )

Returns a new NXOpen.PDM.FileManagement object

Created in NX7.5.4

License requirements: None.

Returns
unsafe void NXOpen.PDM.PdmSession.SetActiveEngineeringChangeNotice ( NXOpen.Part  part,
string  ecnId,
string  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.

Parameters
parttag of the displayed part
ecnIdECN ItemID to be set
ecnRevsionIdECN ItemRevID to be set
unsafe void NXOpen.PDM.PdmSession.SetDefaultFolder ( string  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.

Parameters
defaultFolderSpecDefault folder path including default folder name to be set

Property Documentation

NXOpen.PDM.AttributeGroupDescriptionCollection NXOpen.PDM.PdmSession.AttributeGroupDescriptions
get

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.PartOperationImportObserver NXOpen.PDM.PdmSession.PartOperationImportObserver
get

Returns the NXOpen.PDM.PartOperationImportObserver belonging to this session

Created in NX10.0.0

NXOpen.PDM.SaveAsReviseObserver NXOpen.PDM.PdmSession.SaveAsReviseObserver
get

Returns the NXOpen.PDM.SaveAsReviseObserver belonging to this session

Created in NX11.0.0

Tag NXOpen.PDM.PdmSession.Tag
get

Returns the tag of this object.


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