vsrSavePreset
vsrSavePreset(
t_PresetLabel
t_fileName
[ ?directory t_directory ][ ?path t_path ]
[ ?tooltip t_tooltip ]
[ ?description t_description ]
[ ?iconFileName t_iconFileName ]
[ ?iconText t_iconText ]
[ ?location s_location ]
[ ?mode s_mode ]
[ ?envGroups l_envGroups ]
) ;
=> t / nil
Description
Saves the current settings to a preset file for later re-use.
Arguments
|
t_PresetLabel
|
The label of the preset file, saved as the [label]: keyword in the preset file. This preset label is used as an icon on the VSR Preset toolbar if both ?iconText and ?iconFileName are not specified or as an option name in the drop-down menu of the VSR Preset Load icon.
|
|
t_fileName
|
The name of the preset file without .preset extension.
|
|
t_directory
|
The location of the preset file. It can have one of the following values:
-
".": 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.
|
|
t_tooltip
|
Saves as the [tooltip]: keyword in the preset file. This tooltip is displayed when the mouse cursor is placed on the preset icon. Default is empty string.
|
|
t_description
|
Saves as the [description]: keyword in the preset file. Default is empty string.
|
|
t_iconFileName
|
Saves as the [icon]: keyword in the preset file. This is the name of the icon file for a particular preset. Default is empty string.
|
|
t_iconText
|
Saves as the [iconText]: keyword in the preset file. This text appears on the created icon for a preset. Default is empty string.
|
|
s_location
|
The value of this option can be saved either as 'menu or 'toolbar. It is saved as the [location]: keyword in the preset file. Default is 'menu.
|
|
s_mode
|
The mode controls how the Virtuoso Studio Design Environment is written. There are two modes:
-
'all saves current values of all VSR–related Virtuoso Studio Design Environment variables. This is the default mode. -
'edited saves only the VSR–related Virtuoso Studio Design Environment variables that have values different from their default .cdsenv values.
|
|
l_envGroups
|
Controls which VSR–related Virtuoso Studio Design Environment group value is to be written. This is a list and can be one or more of the following values. The default value is nil, which means that all of the environment group values are written.
-
'designSetup the environment variables in the Design Setup section of the Virtuoso Space-based Router Options form. -
'automatic all automatic routing (includes optimization, fix errors, delete) related environment variables. -
'p2t all pin to trunk related environment variables -
'interactive all wire editing related environment variables.
|
Value Returned
|
t
|
The preset file is saved.
|
|
nil
|
The function is unable to save the preset file.
|
Examples
Saves all the changed design setup and automatic environment variables to file OptimizeRouting.preset in the $HOME/.cadence/dfII/ia/presets directory with Optimize Routing as its label and Opt Route as the toolbar icon text.
(vsrSavePreset "Env Group" "envGroups" ?mode 'edited)
(vsrSavePreset "Optimize Routing"
"OptimizeRouting"
?directory "$HOME"
?iconText "Opt Route"
?location 'toolbar
?mode 'edited
?envGroups (list 'designSetup 'automatic)
)
Related Topics
Space-based Router Functions
Return to top
