Represents the NX Manager session More...

Inheritance diagram for NXOpen.PDM.PdmSession:

Public Member Functions
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.ExportWorksetForReferenceBuilder	CreateExportWorksetForReferenceBuilder (NXOpen.BasePart workset)
	Creates a new NXOpen.PDM.ExportWorksetForReferenceBuilder object used for exporting workset outside Teamcenter for reference. More...

unsafe NXOpen.PDM.ExternalFileReferenceListBuilder	CreateExternalFileReferenceListBuilder (NXOpen.NXObject[] objects)
	Creates a new NXOpen.PDM.ExternalFileReferenceListBuilder object. More...

unsafe void	CreateFolder (string newFolderName, string parentFolderName)
	Create folder in Teamcenter with newFolderName under parentFolderName. More...

unsafe NXOpen.PDM.PartOperationImportBuilder	CreateImportOperationBuilder ()
	Returns a new NXOpen.PDM.PartOperationImportBuilder object More...

unsafe NXOpen.PDM.PartOperationMakeUniqueBuilder	CreateMakeUniqueOperationBuilder (NXOpen.BasePart part)
	Returns a new NXOpen.PDM.PartOperationMakeUniqueBuilder object More...

unsafe NXOpen.PDM.ObjectCreateBuilder	CreateObjectCreateBuilder (string[] tcTypes, string[] baseTCTypes)
	Returns a new NXOpen.PDM.ObjectCreateBuilder object More...

unsafe NXOpen.PDM.PartOperationBuilder	CreateOperationBuilder (NXOpen.PDM.PartOperationBuilder.OperationType operation)
	Returns a new NXOpen.PDM.PartOperationBuilder 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.SmartSaveBuilder	CreateSmartSaveBuilder (NXOpen.PDM.SmartSaveBuilder.SaveType saveType)
	Creates a new SmartSaveBuilder object. More...

unsafe NXOpen.PDM.SmartSaveBuilder	CreateSmartSaveBuilderWithContext (NXOpen.PDM.SmartSaveContext smartSaveContext)
	Creates a new SmartSaveBuilder object. More...

unsafe NXOpen.PDM.SmartSaveContext	CreateSmartSaveContext (NXOpen.PDM.SmartSaveBuilder.SaveType saveType)
	Creates a new SmartSaveContext object. More...

unsafe void	GetCheckedoutStatusOfAllObjectsInSession (out NXOpen.NXObject[] checkedOutObjects, out NXOpen.NXObject[] uncheckedOutObjects)
	Returns the checkedout status (checkedout/non checkedout) of all the objects open in NX. More...

unsafe NXOpen.PDM.DatabaseObjectManager	GetDatabaseObjectManager ()
	Gets the NXOpen.PDM.DatabaseObjectManager object. More...

unsafe string[]	GetItemTypes ()
	Returns array of all available Teamcenter Item Types 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	GetTcserverSettings (out string connectString, out string discriminator)
	Returns the connect string and discriminator used by NX session to connect to the Tcserver. More...

unsafe string	GetUserGroup ()
	Gets the Teamcenter user group for the current user More...

unsafe string	GetUserName ()
	Gets the Teamcenter user name for the current user More...

unsafe string	GetUserRole ()
	Gets the Teamcenter role for the current user More...

unsafe NXOpen.PDM.CAEFileContainer	NewCaeFileContainer ()
	Returns a new NXOpen.PDM.CAEFileContainer object More...

unsafe NXOpen.PDM.FileManagement	NewFileManagement ()
	Returns a new NXOpen.PDM.FileManagement object More...

unsafe void	SetActiveEngineeringChangeNotice (NXOpen.NXObject part, string ecnMFKId, string ecnRevsionId)
	Sets active Engineering Change Notice (ECN) for the session. More...

unsafe void	SetDefaultFolder (string defaultFolderSpec)
	Sets default folder. More...

unsafe void	SetNativeMode (bool enable, bool rereadTemplateInformation)
	Sets or unsets native mode for the session based on the value of input. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
NXOpen.PDM.AttributeGroupDescriptionCollection	AttributeGroupDescriptions `[get]`
	Returns a collection of NXOpen.PDM.AttributeGroupDescription objects representing attribute group types. More...

NXOpen.PDM.PartNameGenerator	PartNameGenerator `[get]`
	Returns the NXOpen.PDM.PartNameGenerator instance belonging to this session 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...

NXOpen.PDM.SaveManagement.SaveObserver	SaveObserver `[get]`
	Returns the NXOpen.PDM.SaveManagement.SaveObserver belonging to this session More...

Tag	Tag `[get]`
	Returns the tag of this object. More...

NXOpen.PDM.TcinUtils	TcinUtils `[get]`
	Returns the NXOpen.PDM.TcinUtils instance belonging to this session More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> 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 )

inline

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 )

inline

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 )

inline

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

workset workset assembly to export

Returns

unsafe NXOpen.PDM.ExternalFileReferenceListBuilder NXOpen.PDM.PdmSession.CreateExternalFileReferenceListBuilder ( NXOpen.NXObject[] objects )

inline

Creates a new NXOpen.PDM.ExternalFileReferenceListBuilder object.

Created in NX1847.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

objects the array of objects

Returns

unsafe void NXOpen.PDM.PdmSession.CreateFolder	(	string	newFolderName,
		string	parentFolderName
	)

inline

Create folder in Teamcenter with newFolderName under parentFolderName.

Created in NX1847.0.0

License requirements: None.

Parameters

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

unsafe NXOpen.PDM.PartOperationImportBuilder NXOpen.PDM.PdmSession.CreateImportOperationBuilder ( )

inline

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 )

inline

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
	)

inline

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 )

inline

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 )

inline

Creates a new NXOpen.PDM.PartOperationAttributePropertiesBuilder object.

Created in NX10.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

objects the array of objects

Returns

unsafe NXOpen.AttributePropertiesBuilder NXOpen.PDM.PdmSession.CreatePartOperationValidationPropertiesBuilder ( NXOpen.NXObject[] objects )

inline

Creates a new AttributePropertiesBuilder object.

Created in NX10.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

objects the array of objects

Returns

unsafe NXOpen.PDM.SmartSaveBuilder NXOpen.PDM.PdmSession.CreateSmartSaveBuilder ( NXOpen.PDM.SmartSaveBuilder.SaveType saveType )

inline

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 )

inline

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 )

inline

Creates a new SmartSaveContext object.

Created in NX11.0.1

License requirements: None.

Parameters

saveType

Returns

unsafe void NXOpen.PDM.PdmSession.GetCheckedoutStatusOfAllObjectsInSession	(	out NXOpen.NXObject[]	checkedOutObjects,
		out NXOpen.NXObject[]	uncheckedOutObjects
	)

inline

Returns the checkedout status (checkedout/non checkedout) of all the objects open in NX.

Created in NX12.0.2

License requirements: None.

Parameters

checkedOutObjects	Array of NXObjects which are open in session and checked out
uncheckedOutObjects	Array of NXObjects which are open in session but not checkout

unsafe NXOpen.PDM.DatabaseObjectManager NXOpen.PDM.PdmSession.GetDatabaseObjectManager ( )

inline

Gets the NXOpen.PDM.DatabaseObjectManager object.

Created in NX11.0.0

License requirements: None.

Returns

unsafe string [] NXOpen.PDM.PdmSession.GetItemTypes ( )

inline

Returns array of all available Teamcenter Item Types

Created in NX1847.0.0

License requirements: None.

Returns

unsafe void NXOpen.PDM.PdmSession.GetSsoSettings	(	out bool	isSsoEnabled,
		out string	ssoServerUrl,
		out string	ssoAppID
	)

inline

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

isSsoEnabled	if SSO is enabled
ssoServerUrl	the SSO server URL
ssoAppID	the SSO app id

unsafe void NXOpen.PDM.PdmSession.GetTcserverSettings	(	out string	connectString,
		out string	discriminator
	)

inline

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

connectString	the connection string
discriminator	the discriminator

unsafe string NXOpen.PDM.PdmSession.GetUserGroup ( )

inline

Gets the Teamcenter user group for the current user

Created in NX1847.0.0

License requirements: None.

Returns

unsafe string NXOpen.PDM.PdmSession.GetUserName ( )

inline

Gets the Teamcenter user name for the current user

Created in NX1847.0.0

License requirements: None.

Returns

unsafe string NXOpen.PDM.PdmSession.GetUserRole ( )

inline

Gets the Teamcenter role for the current user

Created in NX1847.0.0

License requirements: None.

Returns

unsafe NXOpen.PDM.CAEFileContainer NXOpen.PDM.PdmSession.NewCaeFileContainer ( )

inline

Returns a new NXOpen.PDM.CAEFileContainer object

Created in NX8.5.0

License requirements: None.

Returns

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

inline

Returns a new NXOpen.PDM.FileManagement object

Created in NX7.5.4

License requirements: None.

Returns

unsafe void NXOpen.PDM.PdmSession.SetActiveEngineeringChangeNotice	(	NXOpen.NXObject	part,
		string	ecnMFKId,
		string	ecnRevsionId
	)

inline

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.

Parameters

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

unsafe void NXOpen.PDM.PdmSession.SetDefaultFolder ( string defaultFolderSpec )

inline

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

defaultFolderSpec Default folder path including default folder name to be set

unsafe void NXOpen.PDM.PdmSession.SetNativeMode	(	bool	enable,
		bool	rereadTemplateInformation
	)

inline

Sets or unsets native mode for the session based on the value of input.

Created in NX12.0.1

License requirements: None.

Parameters

enable	flag to specify whether to set or unset native mode
rereadTemplateInformation	flag to specify whether to re-initialize managed templates

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

get

Returns the NXOpen.PDM.PartNameGenerator instance belonging to this session

Created in NX1899.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

NXOpen.PDM.SaveManagement.SaveObserver NXOpen.PDM.PdmSession.SaveObserver

get

Returns the NXOpen.PDM.SaveManagement.SaveObserver belonging to this session

Created in NX12.0.1

Tag NXOpen.PDM.PdmSession.Tag

get

Returns the tag of this object.

NXOpen.PDM.TcinUtils NXOpen.PDM.PdmSession.TcinUtils

get

Returns the NXOpen.PDM.TcinUtils instance belonging to this session

Created in NX11.0.1

The documentation for this class was generated from the following file:

PDM_PdmSession.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation