Product Documentation
Virtuoso ADE SKILL Reference
Product Version IC23.1, November 2023

sevConvertStateFormat

sevConvertStateFormat(
[ ?libs l_libs ]
[ ?stateDir t_stateDir ]
[ ?viewType t_viewType ]
[ ?format t_format ]
[ ?backup g_backup ]
[ ?recover g_recover ]
[ ?autoCheckin g_autoCheckin ]
[ ?popUpWarnWin g_popUpWarnWin ]
=> t / nil

Description

Translates all ADE XL states from normal to XML format in the current directory. This function can also be used to do translate a specific parameter set. You can use this function in the OCEAN script and perform the translation in a batch.

Arguments

?libs l_libs

Library for which the state is to be converted. For example, evaluation, list("evaluation" "tes") or all.
If you do not specify a library, all libraries under current directory are searched and converted. For read-only states, a warning message is printed.

For ADE XL, the search is based on data.sdb. For state view, search is based on ADE_state.info.

?stateDir t_stateDir

State directories that are not under tool default search directory. It works when viewType is set to stateview. It is used to convert state file for ADE L state.

?viewType t_viewType

Sets the state property.

The valid values are adexl, stateview, and all. If no view type is specified, adexl view is used.

?format t_format

Specify the format in which the state is to be converted

The possible values are xml and files.

The default value is xml.

?backup g_backup

Sets the directory used to backup the original state.

The possible values are t and nil.

The default value is nil.

When this argument is set to t, the function creates a backup library of the directory and files, such as data.sdb, test_states, that are present in the view to be changed.

?recover g_recover

Recovers the state automatically with the latest backup data. When both backup and recover arguments are set to t, backup is ignored.

The default value is nil.

?autoCheckin g_autoCheckin

Checks in view automatically under the DM environment.

The default value is nil.

?popUpWarnWin g_popUpWarnWin

Controls the display of the warning message when the state starts getting converted. It can be used in converting state by script.

Value Returned

t

All ADE XL states are translated from normal to XML format in the current directory.

nil

The ADE XL states are not translated.

Examples

Converts all adexl views under current directory from the files format to xml format.

sevConvertStateFormat() 

Converts the adexl view under evaluation library to files format and also creates a backup of original state under directory /home/user/backup.

sevConvertStateFormat(?libs “evaluation” ?format ‘files ?backup “/home/user/backup”)

Recovers the adexl view under evaluation library from backup directory /home/user/backup

sevConvertStateFormat(?libs “evaluation” ?format ‘files ?backup “/home/user/backup” ?recover t)

Converts the ADE L state under directory /home/user/artist_state to the xml format.

sevConvertStateFormat(?stateDir “/home/user/artist_state” ?viewType ‘stateview ) 

Converts the adexl view under evaluation library to xml format and check in the view automatically under DM environment.

sevConvertStateFormat(?libs “evaluation” ?autoCheckin t) 

Return to top
 ⠀
X