schHiCreateSymbolPin
schHiCreateSymbolPin(
[ ?terminalName t_terminalName ]
[ ?type t_type ]
[ ?direction t_direction ]
[ ?interpret t_interpret ]
[ ?mode t_mode ]
[ ?incrCount n_incrCount ]
[ ?location t_location ]
)
=> t
Description
Creates pins in a symbol. Usable only when editing symbols.
If you do not specify t_terminalName or you specify it as nil, the options form appears and prompts you to change any of the fields.
While dragging the appropriate pin master to a location, click. If you did not set t_location to none, a label is placed to display the terminal name.
Arguments
|
?terminalName t_terminalName
|
|
|
Terminal name of the pin; must be enclosed in quotation marks. To create more than one terminal name, use a space between names as a delimiter.
|
|
?type t_type
|
|
|
Type of pin; must be enclosed in quotation marks. The value must be an entry in the schSymbolPinMasters map.
|
|
?direction t_direction
|
|
|
Direction of the pin; must be enclosed in quotation marks.
Valid Values: input, output, inputOutput, switch
|
|
?interpret t_interpret
|
|
|
Interprets t_terminalName; must be enclosed in quotation marks. If you set t_interpret to member, a pin for each member name in t_terminalName is generated in the order presented in t_terminalName. If you set t_interpret to full, a pin for each space-delimited terminal name from t_terminalName is placed individually.
Valid Values: full, member
|
|
?mode t_mode
|
|
|
Mode used to place pins; must be enclosed in quotation marks. If you set t_mode to single, the schematic editor drags each described pin and prompts you for a location to place each one. If you set t_mode to array, the schematic editor places the current pin as if in single mode. Then, if there are any remaining pins to place, it prompts you for a second point that sets the offset between the remaining pins.
Valid Values: single, array
|
|
?incrCount n_incrCount
|
|
|
Distance between the pin and the label.
Valid Values: 0 through 32
Default: 1
|
|
?location t_location
|
|
|
Location of the terminal name label; must be enclosed in quotation marks.
Value Values: left, right, none
|
Value Returned
Examples
Creates a square input symbol pin using the pin master. Drags the pin with a label to the left until you select a destination point. The editor designates the pin name data1.
schHiCreateSymbolPin( "data1" "square" "input" "full" "single" 0 "left" )
For each member name addr<7> through addr<0>, you can drag and place a symbol input pin with a label to the left of the pin.
The input pins are named with the individual member names.
schHiCreateSymbolPin( "addr<7:0>" "square" "input" "member" "single" 0 "left" )
Places a pin for each space-delimited terminal name data1, data2, and data3.
schHiCreateSymbolPin( "data1 data2 data3" "square" "input" "full" "single" 0 "left" )
Places an array of symbol input pins.
schHiCreateSymbolPin( "addr<7:0>" "square" "input" "member" "array" )
Related Topics
schSymbolPinMasters
Return to top
