Product Documentation
Virtuoso Schematic Editor SKILL Functions Reference
Product Version IC23.1, November 2023

schRegisterCheckGroup

schRegisterCheckGroup( 
[ ?name s_name ]
[ ?title t_title ] 
[ ?description t_description ]
[ ?enabled g_enabled ]
)
=> r_checkgroup / nil

Description

Creates and registers a new custom schematic checker group. Each new group appears as a discrete tab in the Schematic Rules Checks Setup form. Calling the function with the same group name as an existing group overwrites that group and all its rules.

Arguments

?name s_name

Symbolic name of the group which must be referenced when registering checks.

?title t_title

Tab title in the user interface. The default value is the s_name text.

?description t_description

Description for the custom schematic checker group.

?enabled g_enabled

Specifies whether the rules in this group should be run by default. Disabled groups will be shown grayed out in the user interface. The default value is t.

Value Returned

r_checkgroup

The new schCheckGroup structure was created and appears in the association list returned.

nil

The schCheckGroup structure could not be created.

Examples

(schRegisterCheckGroup
    ?name         'ercChecks
    ?title        "ERC"
    ?description  "Electrical Rule Checks"
    ?enabled      t)
=> schCheckGroup@0xfea8b98

Related Topics

Creating Custom Checks


Return to top
 ⠀
X