This repository has been archived by the owner on Mar 4, 2023. It is now read-only.
/
CaeKerPrefs.py
58 lines (44 loc) · 1.79 KB
/
CaeKerPrefs.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
from abaqusConstants import *
class CaeKerPrefs:
"""The CaeKerPrefs object contains the details of the sessionOptions.
Attributes
----------
fileName: str
A String specifying the path to the preferences file that the :py:class:`~abaqus.AbaqusCAEDisplayPreferences.CaeKerPrefs.CaeKerPrefs` object
represents.
Notes
-----
This object can be accessed by:
.. code-block:: python
import caePrefsAccess
caePrefsAccess.openSessionOptions(...)
"""
# A String specifying the path to the preferences file that the CaeKerPrefs object
# represents.
fileName: str = ""
def save(self, backupFile: Boolean = OFF):
"""This method saves the sessionOptions in the current *fileName*.
Parameters
----------
backupFile: Boolean
A Boolean specifying whether save a numbered backup copy of the preferences file,
**fileName**. Default is True.
"""
pass
def saveAs(self, fileName: str, directory: SymbolicConstant):
"""This method saves the sessionOptions to the specified location.
Parameters
----------
fileName: str
A String specifying the path to the preferences file.
directory: SymbolicConstant
A SymbolicConstant specifying the location of the preferences file. Possible values
are:
- CURRENT to open the preferences file in the current directory
(caePrefsAccess.CURRENT)
- HOME to open the preferences file in your home directory
(caePrefsAccess.HOME)
The default value is HOME. Either **fileName** or **directory** must be
supplied. The **fileName** or **directory** arguments are mutually exclusive.
"""
pass