PreferencesVDF#

class ansys.stk.core.stkobjects.PreferencesVDF#: Allow configuring VDF preferences.

Overview#

Properties

`base_directory`	Get or set the Base Directory where VDF file is extracted.
`save_scenario_as_vdf`	Get or set the SaveScenarioAsVDF property determines whether a scenario will be saved as a scenario file or as a VDF file when the Save method is called. If a VDF file is loaded, then the SaveScenarioAsVDF property has no effect when Save is called.

Import detail#

from ansys.stk.core.stkobjects import PreferencesVDF

Property detail#

property PreferencesVDF.base_directory: str#: Get or set the Base Directory where VDF file is extracted.

property PreferencesVDF.save_scenario_as_vdf: bool#

Get or set the SaveScenarioAsVDF property determines whether a scenario will be saved as a scenario file or as a VDF file when the Save method is called. If a VDF file is loaded, then the SaveScenarioAsVDF property has no effect when Save is called.

Examples#

Save the current scenario as a VDF

# STKObjectRoot root: STK Object Model Root
scenario = root.current_scenario
root.preferences.vdf_preferences.save_scenario_as_vdf = True