Altera Quartus II Scripting - Manual (Page 330)

3–200 Chapter 3: Tcl Packages & Commands
project
Quartus II Scripting Reference Manual © July 2013 Altera Corporation
get_all_parameters
Usage
get_all_parameters [-entity <entity_name>] -name <name> [-tag <data>] [-to
<destination>]
Options
-entity <entity_name>: Entity to which parameter belongs
-name <name>: Parameter name (string pattern is matched using Tcl string matching)
-tag <data>: Option to tag data to this assignment
-to <destination>: Destination of the parameter (string pattern is matched using Tcl
string matching)
Description
Returns a filtered output collection of all matching parameter 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 ::quartus::project package, two new Tcl commands "get_all_assignments" and
"get_assignment_info" have been introduced to replace the "get_all_parameters" command. These two
new commands simplify the interface to retrieve information about Quartus II Settings File (.qsf)
assignments. The "get_all_parameters" command is still supported for backward compatibility.
The "-name" option is not case sensitive. The "-to" option is case sensitive.
If the "-to" argument is specified, the function returns the parameter values for the current entity. The
values are retrieved from the PARAMETERS section of the entity. Otherwise, the function returns the
project-wide default parameter values obtained from the DEFAULT_PARAMETERS section.
This Tcl command filters the parameter data found in the Quartus II Settings File (.qsf) and outputs the
data based on the values specified by the "-name" and "-to" options. 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_parameters -name * -to a[0]
# To match all indices of bus "a", type:
get_all_parameters -name * -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_parameters -name * -to "a[escape_brackets \[]\[0-2\][escape_brackets \]]"
For more information about escaping square brackets, type "escape_brackets -h".
Each element of the collection is a list with the following format: { {<Destination>} {<Parameter name>}
{<Parameter value>} {<Entity name>} {<Tag data>} }