Product Documentation
Virtuoso Space-based Router Command Reference
Product Version IC23.1, September 2023

scheme

scheme
{-create s_name [ -package s_pkgName ] [ -overwrite [ true | false ] ]
| -copy s_name -from s_name [ -package s_pkgName ] [ -overwrite [ true | false ] ]
| -rename s_name -from s_name [ -overwrite [ true | false ] ]
| -delete s_name [ -package s_pkgName ] 
| -activate s_name [ -package s_pkgName ]
| -comment s_name -value s_text 
| -compare s_name -against s_name [ -package s_pkgName ]}

Description

Performs operations for managing schemes.

Schemes provide a method for quickly saving and restoring environment variables used for some Space-based Router functions. Each group of environment variables is defined and manipulated by a scheme package. The default scheme is initialized by Space-based Router, determines the available package types and the environment variables included in each package, and is used when creating new schemes.

You can create multiple schemes using the -create and -copy arguments. In addition, one scheme for each package type is the current or active scheme. This is the scheme used by the function associated with the package for its next run.

Arguments

-activate s_name

Specifies the name of the scheme (if -package is not given) or the scheme package (if -package is given) to make active.

-against s_name

Specifies the name of the scheme to compare against the scheme given by the -compare argument value.

-comment s_name

Specifies the name of the scheme to add the comment to.

-compare s_name

Specifies the name of the scheme to compare against the scheme given by the -against argument value.

-copy s_name

Specifies the name of the scheme to create by copying the scheme given by the -from argument. By default, all scheme packages are copied. If the -package argument is given, only the given scheme package is copied.

-create s_name

Specifies the name of the scheme to create by copying the default scheme settings. By default, all default scheme packages are copied. If the -package argument is given, only the given scheme package is copied.

-delete s_name

Specifies the name of the scheme to delete. The default scheme cannot be deleted.

-from s_name

Specifies the name of the scheme to copy from (if -copy is given) or to rename (if -rename is given).

-overwrite [ true | false ]

For copy, create and rename functions, if true, forces the target scheme or scheme package to be overwritten, if it already exists. If not set true and the target scheme or scheme package already exists, a warning message is issued and no action is taken.

-package s_pkgName

Limits the function to the given package.

-rename s_name

Renames the scheme given by the -from argument to the given name.

-value s_text

Specifies the text to add to the scheme given by the -comment argument.

Examples

The following commands are equivalent. Each command creates a new scheme, myScheme, from the default scheme.

scheme -create myScheme 
scheme -copy myScheme -from default

The following command activates the power_cell_rows package of the myScheme scheme. Assuming that the default scheme is active, all default scheme packages will be active except for the power_cell_rows package after this command is issued.

scheme -activate myScheme -package power_cell_rows

Related Topics

Edit Commands


Return to top
 ⠀
X