Abaqus CAE Display Preferences¶

Display preferences commands are used to edit the Abaqus/CAE preferences file, abaqus_2021.gpr.

Other Classes¶

class CaeGuiPrefs[source]¶

Bases: object

The CaeGuiPrefs object contains the details of the graphical preferences in a guiPreferences section of the abaqus_2021.gpr file.

Note

This object can be accessed by:

import caePrefsAccess
caePrefsAccess.openGuiPreferences(...)

Note

Check CaeGuiPrefs on help.3ds.com/2020.

Member Details:

fileName : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the path to the preferences file.

save(backupFile=True)[source]¶

This method saves the guiPreferences section specified in the current fileName.

Note

Check CaeGuiPrefs.save on help.3ds.com/2020.

Parameters:¶

backupFile=True¶: A Boolean specifying whether Abaqus should save a numbered backup copy of the preferences file, fileName. Default is True.

saveAs(fileName)[source]¶

This method saves the guiPreferences settings to the specified location.

Note

Check CaeGuiPrefs.saveAs on help.3ds.com/2020.

Parameters:¶

fileName¶: A String specifying the path to the preferences file.

class CaeKerPrefs[source]¶

Bases: object

The CaeKerPrefs object contains the details of the sessionOptions.

Note

This object can be accessed by:

import caePrefsAccess
caePrefsAccess.openSessionOptions(...)

Note

Check CaeKerPrefs on help.3ds.com/2020.

Member Details:

fileName : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the path to the preferences file that the CaeKerPrefs object represents.

save(backupFile=0)[source]¶

This method saves the sessionOptions in the current fileName.

Note

Check CaeKerPrefs.save on help.3ds.com/2020.

Parameters:¶

backupFile=0¶: A Boolean specifying whether save a numbered backup copy of the preferences file, fileName. Default is True.

saveAs(fileName='', directory=HOME)[source]¶

This method saves the sessionOptions to the specified location.

Note

Check CaeKerPrefs.saveAs on help.3ds.com/2020.

Parameters:¶

fileName=''¶

A String specifying the path to the preferences file.

directory=HOME¶

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.

getDisplayNamesInGuiPreferences(fileName)[source]¶

The abaqus_2021.gpr file stores a separate guiPreferences record for each display that you use. This function returns a list of every displayName recorded in the preferences file.

Note

This function can be accessed by:

caePrefsAccess.getDisplayNamesInGuiPreferences

Note

Check caePrefsAccess.getDisplayNamesInGuiPreferences on help.3ds.com/2020.

Parameters:¶

fileName¶: A String that specifies the path to the preferences file.

Returns:¶

A list of Strings of displayNames.

Return type:¶

list[str]

getGuiPrefsFileName()[source]¶

This function enables you to retrieve the location of your abaqus_2021.gpr file.

Note

This function can be accessed by:

caePrefsAccess.getGuiPrefsFileName

Returns:¶: A String with the default file name for the GUI preferences file.
Return type:¶: str

openGuiPreferences(displayName, fileName='')[source]¶

This function enables you to examine and change many default behaviors in the Abaqus/CAE graphical user interface. Abaqus stores preferences for each display you use in a separate guiPreferences section of the abaqus_2021.gpr file.

Note

This function can be accessed by:

caePrefsAccess.openGuiPreferences

Note

Check caePrefsAccess.openGuiPreferences on help.3ds.com/2020.

Parameters:¶

displayName¶: A String that specifies the display for which you want to investigate GUI preferences from the abaqus_2021.gpr file. You can retrieve the available display names in the file by using the getDisplayNamesInGuiPreferences method.
fileName=''¶: A String specifying the path to the preferences file. The openGuiPreferences method uses this argument if you are working with a preferences file that is not at the default location.If this argument is omitted, the abaqus_2021.gpr file in your home directory is opened.

Returns:¶

A CaeGuiPrefs object.

Return type:¶

CaeGuiPrefs

openSessionOptions(fileName='', directory=HOME)[source]¶

This function enables you to examine and change the default behavior for many session options Abaqus/CAE; that is, the settings that you can save in Abaqus/CAE from the FileSave Display ConstrainedSketchOptions menu option. Abaqus stores default session options in the sessionOptions section of the abaqus_2021.gpr file.

Note

This function can be accessed by:

caePrefsAccess.openSessionOptions

Note

Check caePrefsAccess.openSessionOptions on help.3ds.com/2020.

Parameters:¶

fileName=''¶

A String specifying the path to the preferences file. The openSessionOptions method uses this argument if you are working with a preferences file that is not at the default location. If this argument is omitted, the abaqus_2021.gpr file in your home directory is opened.

directory=HOME¶

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.

Returns:¶

A CaeKerPrefs object.

Return type:¶

CaeKerPrefs

printValuesList(object, maxRecursionDepth=UNLIMITED, asString=False)[source]¶

This function enables you to print all of the options and their values for a set of guiPreferences or sessionOptions settings derived from the abaqus_2021.gpr file.

Note

This function can be accessed by:

caePrefsAccess.printValuesList

Note

Check caePrefsAccess.printValuesList on help.3ds.com/2020.

Parameters:¶

object¶: The guiPreferences object or sessionOptions object for which you want to print options and their values.
maxRecursionDepth=UNLIMITED¶: An Int, or SymbolicConstant UNLIMITED, that specifies the depth of recursion when accessing the attributes of object.
asString=False¶: A Boolean specifying how the string representation of each option is printed. If asString is True, printValuesList prints the str of each option; otherwise printValuesList prints the repr of the options. The default value is False.

Returns:¶

A String displaying the path, name, and value for all of the options in the object that you select.

Return type:¶

str