PersistentSettings Class¶
-
class
NXOpen.PDM.
PersistentSettings
¶ Bases:
NXOpen.TransientObject
Persistently held settings for a Teamcenter user account.
Any changes will only take effect when
PDM.PersistentSettings.Apply()
is callsed. .. versionadded:: NX4.0.0
Properties¶
Property | Description |
---|---|
Group | Returns or sets the Teamcenter group in which the user acts by default. |
Volume | Returns or sets the Teamcenter volume to which the user used by default. |
Methods¶
Method | Description |
---|---|
Apply | Applies any changes to the settings |
Dispose | Free resources associated with the instance. |
GetGroups | Gets the names of the Teamcenter groups to which the user belongs. |
GetVolumes | Gets the names of the Teamcenter volumes which the user may use, given the current group returned by PDM.PersistentSettings.GetGroups() . |
Property Detail¶
Group¶
-
PersistentSettings.
Group
¶ Returns or sets the Teamcenter group in which the user acts by default.
Should be one of those given by
PDM.PersistentSettings.GetGroups()
-------------------------------------
Getter Method
Signature
Group()
Returns: Return type: str New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Group(group)
Parameters: group (str) – New in version NX4.0.0.
License requirements: None.
Volume¶
-
PersistentSettings.
Volume
¶ Returns or sets the Teamcenter volume to which the user used by default.
Should be one of those given by
PDM.PersistentSettings.GetVolumes()
-------------------------------------
Getter Method
Signature
Volume()
Returns: Return type: str New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Volume(volume)
Parameters: volume (str) – New in version NX4.0.0.
License requirements: None.
Method Detail¶
Apply¶
-
PersistentSettings.
Apply
¶ Applies any changes to the settings
Signature
Apply()
New in version NX4.0.0.
License requirements: None.
Dispose¶
-
PersistentSettings.
Dispose
¶ Free resources associated with the instance.
After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Signature
Dispose()
New in version NX4.0.0.
License requirements: None.
GetGroups¶
-
PersistentSettings.
GetGroups
¶ Gets the names of the Teamcenter groups to which the user belongs.
Signature
GetGroups()
Returns: the names of the groups Return type: list of str New in version NX4.0.0.
License requirements: None.
GetVolumes¶
-
PersistentSettings.
GetVolumes
¶ Gets the names of the Teamcenter volumes which the user may use, given the current group returned by
PDM.PersistentSettings.GetGroups()
.Signature
GetVolumes()
Returns: the names of the volumes Return type: list of str New in version NX4.0.0.
License requirements: None.