vsrLoadPreset
vsrLoadPreset(
t_fileName
[ ?directory t_directory ]
[ ?execMode s_execMode ]
[ ?path t_path ]
) ;
=> t / nil
Description
Loads a preset file to the Wire Assistant form and the Virtuoso Space-based Router Options form.
Arguments
|
t_fileName
|
The name of the preset file without .preset extension.
|
|
t_directory
|
The location of the preset file:
-
".": The current directory from where Virtuoso is run. The file is loaded from the ./.cadence/dfII/ia/presets directory. This is the default value. -
"$HOME": The user home directory. The file is loaded from the <user-home-directory>/.cadence/dfII/ia/presets directory. -
"$CDS_PROJECT": The directory specified by the CDS_PROJECT shell environment variable.The file is loaded from the $CDS_PROJECT/dfII/ia/presets directory.
|
|
t_path
|
The location of the preset file.
If both ?directory and ?path are specified, then the location specified in the ?path is considered. However, if the ?path is empty, the location specified in ?directory is considered.
|
|
s_execMode
|
The execution mode of the preset file. It can have one of the following two values, 'setting and 'checking. Default is setting .
-
'setting skips any preset entry that has an error and processes and loads all the entries that are error-free. -
'checking processes the entries only if all the entries in the preset file are error free. If even one entry has an error, the function does not process any other entry, even if all others are error free.
|
Value Returned
|
t
|
The preset file is loaded.
|
|
nil
|
The function is unable to load the preset file.
|
Examples
The following example loads the preset file commands from the current run directory.
(vsrLoadPreset "commands")
Loads the preset file M1M2Routing.preset from the $HOME/.cadence/dfII/ia/presets directory but only if the preset file is error-free.
(vsrLoadPreset "M1M2Routing" ?directory "$HOME" ?execMode 'checking)
Loads the preset file M3M5Routing.preset from the $CDS_PROJECT/dfII/ia/presets directory. Valid settings are loaded, but any incorrect settings are skipped.
(vsrLoadPreset "M3M5Routing" ?directory "$CDS_PROJECT" ?execMode 'setting)
Related Topics
Space-based Router Functions
Return to top
