schSetAndLoadTsgTemplateType

schSetAndLoadTsgTemplateType( 
t_tsgType 
[ t_templateFileName ] 
)
=> t / nil

Description

Sets the tsgTemplateType environment variable and loads the corresponding tsg template file.

Use this function to load a new TSG template file to overwrite the currently loaded TSG template file. A TSG template file is automatically loaded when you first create a symbol or first open the Symbol Generation Options form. After that time, a TSG template file is only loaded upon request.

schSetAndLoadTsgTemplateType is the procedural equivalent to the Load button of the Symbol Generation Options form.

A TSG template file contains settings that describe the attributes, labels, and properties that the tsg engine references when creating symbols automatically.

Arguments

t_tsgType	Sets the tsgTemplateType environment variable to this keyword. This keyword indirectly references the full path to a TSG template file using the tsgTemplatesMasters list, which is defined in the schConfig.il file. The Cadence-provided keywords and TSG template files are as follows:
	Keyword	Full Path to tsg Template File
	digital	your_install_dir/tools/dfII/samples/symbolGen/default.tsg
	artist	your_install_dir/tools/dfII/samples/symbolGen/artist.tsg
	PCB	your_install_dir/tools/dfII/samples/symbolGen/package.tsg
	metric	your_install_dir/tools/dfII/samples/symbolGen/metric.tsg
	other	not defined
t_templateFileName
	If you specify other as the t_tsgType keyword, this argument lets you specify the full path to any TSG template file rather than using the tsgType keyword mapping described above.

Value Returned

t	Set the tsgTemplateType environment variable and performs a load of the corresponding tsg template file.
nil	Unsuccessful.

Examples

Assigns the keyword metric to the tsgTemplateType environment variable and reads the settings from the corresponding tsg template file. The system references those settings when creating symbols automatically.

schSetAndLoadTsgTemplateType( "metric" )

Related Topics

Symbol Generation Options Form

TSG template file

Return to top