Altera Quartus II Scripting - Manual (Page 328)

3–198 Chapter 3: Tcl Packages & Commands
project
Quartus II Scripting Reference Manual © July 2013 Altera Corporation
get_all_instance_assignments
Usage
get_all_instance_assignments [-entity <entity_name>] [-from <source>] -name <name>
[-section_id <section id>] [-tag <data>] [-to <destination>]
Options
-entity <entity_name>: Entity to which assignment belongs
-from <source>: Source of assignment (string pattern is matched using Tcl string
matching)
-name <name>: Assignment name (string pattern is matched using Tcl string matching)
-section_id <section id>: Section id
-tag <data>: Option to tag data to this assignment
-to <destination>: Destination of assignment (string pattern is matched using Tcl
string matching)
Description
Returns a filtered output collection of all matching instance assignment values. To access each element of
this output collection, use the Tcl command "foreach_in_collection". To see example usage, type
"foreach_in_collection -long_help".
In version 5.0 of the ::quartus::project package, two new Tcl commands "get_all_assignments" and
"get_assignment_info" have been introduced to replace the "get_all_instance_assignments" command.
These two new commands simplify the interface to retrieve information about Quartus II Settings File
(.qsf) assignments. The "get_all_instance_assignments" command is still supported for backward
compatibility.
The "-name" option is not case sensitive. The "-to" and "-from" options are case sensitive.
These options can take string patterns containing special characters from the set "*?\[]" as values. The
values are matched using Tcl string matching. Note that bus names are automatically detected and do not
need to be escaped. Bus names have the following format:
<bus name>[<bus index>] or <bus name>[*]
The <bus name> portion is a string of alphanumeric characters. The <bus index> portion is an integer
greater than or equal to zero or it can be the character "*" used for string matching. Notice that the <bus
index> is enclosed by the square brackets "[" and "]". For example, "a[0]" and "a[*]" are supported bus
names and can be used as follows:
# To match index 0 of bus "a", type:
get_all_instance_assignments -name LOCATION -to a[0]
# To match all indices of bus "a", type:
get_all_instance_assignments -name LOCATION -to a[*]
All other uses of square brackets must be escaped if you do not intend to use them as string patterns. For
example, to match indices 0, 1, and 2 of the bus "a", type:
get_all_instance_assignments -name LOCATION -to "a[escape_brackets
\[]\[0-2\][escape_brackets \]]"
For more information about escaping square brackets, type "escape_brackets -h".
This Tcl command reads in the instance assignments found in the Quartus II Settings File (.qsf). The
command filters the assignments data found in the .qsf and outputs the data based on the values specified
by the "-name", "-from", and "-to" options.