NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Preferences::SessionPdm Class Reference

Represents the NX Manager preferences for the entire session
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences

Created in NX4.0.1. More...

Public Types

enum  JtUpdateFromSourceType { JtUpdateFromSourceTypeComplete, JtUpdateFromSourceTypeNone }
 Options for the kind of JT update performed when a part is loaded. More...
 
enum  MessagesInconsistentRevisionsType { MessagesInconsistentRevisionsTypeNone, MessagesInconsistentRevisionsTypeWarning, MessagesInconsistentRevisionsTypeError }
 Options for the kind of messages about inconsistent revisions when a part is loaded. More...
 
enum  SynchroniseOnLoadType { SynchroniseOnLoadTypeComplete, SynchroniseOnLoadTypeAddWithTransforms, SynchroniseOnLoadTypeNone }
 Options for the kind of synchronisation with the PDM system performed when a part is loaded. More...
 
enum  SynchroniseOnSaveType { SynchroniseOnSaveTypeComplete, SynchroniseOnSaveTypeNone }
 Options for the kind of synchronisation with the PDM system performed when a part is saved. More...
 
enum  UnpopulatedBehaviourType {
  UnpopulatedBehaviourTypeOnSave, UnpopulatedBehaviourTypeModifiedPrompt, UnpopulatedBehaviourTypeModifiedNoPrompt, UnpopulatedBehaviourTypeNever,
  UnpopulatedBehaviourTypePreNx4
}
 Options for when to add NX datasets upon loading an unpopulated part in the PDM system. More...
 

Public Member Functions

NXOpen::Preferences::SessionPdm::JtUpdateFromSourceType JtUpdateFromSource ()
 Returns the kind of JT update performed when a part is loaded
Created in NX6.0.2. More...
 
NXOpen::Preferences::SessionPdm::MessagesInconsistentRevisionsType MessagesInconsistentRevisions ()
 Returns the kind of messages about inconsistent revisions when a part is loaded
Created in NX6.0.2. More...
 
void SetJtUpdateFromSource (NXOpen::Preferences::SessionPdm::JtUpdateFromSourceType update)
 Sets the kind of JT update performed when a part is loaded
Created in NX6.0.2. More...
 
void SetMessagesInconsistentRevisions (NXOpen::Preferences::SessionPdm::MessagesInconsistentRevisionsType message)
 Sets the kind of messages about inconsistent revisions when a part is loaded
Created in NX6.0.2. More...
 
void SetSynchroniseOnLoad (NXOpen::Preferences::SessionPdm::SynchroniseOnLoadType sync)
 Sets the kind of synchronisation performed when a part is loaded
Created in NX4.0.1. More...
 
void SetSynchroniseOnSave (NXOpen::Preferences::SessionPdm::SynchroniseOnSaveType sync)
 Sets the kind of synchronisation performed when a part is saved
Created in NX4.0.1. More...
 
void SetUnpopulatedBehaviour (NXOpen::Preferences::SessionPdm::UnpopulatedBehaviourType behaviour)
 Sets the behaviour when an unpopulated part is loaded
Created in NX4.0.1. More...
 
NXOpen::Preferences::SessionPdm::SynchroniseOnLoadType SynchroniseOnLoad ()
 Returns the kind of synchronisation performed when a part is loaded
Created in NX4.0.1. More...
 
NXOpen::Preferences::SessionPdm::SynchroniseOnSaveType SynchroniseOnSave ()
 Returns the kind of synchronisation performed when a part is saved
Created in NX4.0.1. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
NXOpen::Preferences::SessionPdm::UnpopulatedBehaviourType UnpopulatedBehaviour ()
 Returns the behaviour when an unpopulated part is loaded
Created in NX4.0.1. More...
 

Detailed Description

Represents the NX Manager preferences for the entire session
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences

Created in NX4.0.1.


Member Enumeration Documentation

Options for the kind of JT update performed when a part is loaded.

Enumerator
JtUpdateFromSourceTypeComplete 

complete

JtUpdateFromSourceTypeNone 

none

Options for the kind of messages about inconsistent revisions when a part is loaded.

Enumerator
MessagesInconsistentRevisionsTypeNone 

none

MessagesInconsistentRevisionsTypeWarning 

warning

MessagesInconsistentRevisionsTypeError 

error

Options for the kind of synchronisation with the PDM system performed when a part is loaded.

Enumerator
SynchroniseOnLoadTypeComplete 

complete

SynchroniseOnLoadTypeAddWithTransforms 

add with transforms

SynchroniseOnLoadTypeNone 

none

Options for the kind of synchronisation with the PDM system performed when a part is saved.

Enumerator
SynchroniseOnSaveTypeComplete 

complete

SynchroniseOnSaveTypeNone 

none

Options for when to add NX datasets upon loading an unpopulated part in the PDM system.

Enumerator
UnpopulatedBehaviourTypeOnSave 

on save

UnpopulatedBehaviourTypeModifiedPrompt 

modified prompt

UnpopulatedBehaviourTypeModifiedNoPrompt 

modified no prompt

UnpopulatedBehaviourTypeNever 

never

UnpopulatedBehaviourTypePreNx4 

pre nx4

Member Function Documentation

NXOpen::Preferences::SessionPdm::JtUpdateFromSourceType NXOpen::Preferences::SessionPdm::JtUpdateFromSource ( )

Returns the kind of JT update performed when a part is loaded
Created in NX6.0.2.



License requirements : None

NXOpen::Preferences::SessionPdm::MessagesInconsistentRevisionsType NXOpen::Preferences::SessionPdm::MessagesInconsistentRevisions ( )

Returns the kind of messages about inconsistent revisions when a part is loaded
Created in NX6.0.2.



License requirements : None

void NXOpen::Preferences::SessionPdm::SetJtUpdateFromSource ( NXOpen::Preferences::SessionPdm::JtUpdateFromSourceType  update)

Sets the kind of JT update performed when a part is loaded
Created in NX6.0.2.



License requirements : None

Parameters
updateupdate
void NXOpen::Preferences::SessionPdm::SetMessagesInconsistentRevisions ( NXOpen::Preferences::SessionPdm::MessagesInconsistentRevisionsType  message)

Sets the kind of messages about inconsistent revisions when a part is loaded
Created in NX6.0.2.



License requirements : None

Parameters
messagemessage
void NXOpen::Preferences::SessionPdm::SetSynchroniseOnLoad ( NXOpen::Preferences::SessionPdm::SynchroniseOnLoadType  sync)

Sets the kind of synchronisation performed when a part is loaded
Created in NX4.0.1.



License requirements : None

Parameters
syncsync
void NXOpen::Preferences::SessionPdm::SetSynchroniseOnSave ( NXOpen::Preferences::SessionPdm::SynchroniseOnSaveType  sync)

Sets the kind of synchronisation performed when a part is saved
Created in NX4.0.1.



License requirements : None

Parameters
syncsync
void NXOpen::Preferences::SessionPdm::SetUnpopulatedBehaviour ( NXOpen::Preferences::SessionPdm::UnpopulatedBehaviourType  behaviour)

Sets the behaviour when an unpopulated part is loaded
Created in NX4.0.1.



License requirements : None

Parameters
behaviourbehaviour
NXOpen::Preferences::SessionPdm::SynchroniseOnLoadType NXOpen::Preferences::SessionPdm::SynchroniseOnLoad ( )

Returns the kind of synchronisation performed when a part is loaded
Created in NX4.0.1.



License requirements : None

NXOpen::Preferences::SessionPdm::SynchroniseOnSaveType NXOpen::Preferences::SessionPdm::SynchroniseOnSave ( )

Returns the kind of synchronisation performed when a part is saved
Created in NX4.0.1.



License requirements : None

tag_t NXOpen::Preferences::SessionPdm::Tag ( ) const

Returns the tag of this object.

NXOpen::Preferences::SessionPdm::UnpopulatedBehaviourType NXOpen::Preferences::SessionPdm::UnpopulatedBehaviour ( )

Returns the behaviour when an unpopulated part is loaded
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.