Filter
Top Products
Development System Reference Guide www.xilinx.com 85
Tcl Commands for Advanced Scripting
R
foreach (iterate over elements in a collection)
The collection foreach command iterates over each object in a collection through an iterator
variable. The iterator variable specifies the collection to interate over and the set of
commands or script to apply at each iteration.
% collection foreach <iterator_variable> <collection_variable> {body}
collection is the name of the Xilinx Tcl command.
foreach is the name of the collection subcommand.
iterator_variable specifies the name of the iterator variable.
collection_variable specifies the name of the collection to iterate through.
body specifies a set of commands or script to execute at each iteration.
Caution!
You cannot use the standard Tcl-supplied foreach command to iterate over
collections. You must use the Xilinx-specific collection foreach command. Using the Tcl-supplied
foreach command may cause the collection to be deleted.
get (get collection property)
The collection get command returns the value of the specified collection property. Collection
properties and values are assigned with the collection set command.
collection get <property_name>
collection is the name of the Xilinx Tcl command.
get is the name of the collection subcommand.
property_name specifies the name of the property you wish to get the value of. Valid
property names for the collection get command are display_line_limit and display_type.
Example: % set colVar [search * -type instance]
% collection foreach itr $colVar {
puts [object name $itr]}
Description: In this example, the set command is used in the first line to assign a
collection of instances to the colVar collection variable.
In the second line, the collection foreach command is used to iterate
over each object in the colVar collection.
itr is the name of the iterator variable.
Curly braces { } enclose the body, which is the script that executes at
each iteration. Note that the object name command is nested in the
body to return the value of the iterator variable, which is an instance
in this case.
Tcl Return: An integer return of the number of times the script was executed.
Example: % collection get display_type
Description: In this example, the collection get command is used to get the current
setting of the display_type property.
Tcl Return: The set value of the specified property.