Remove_all_parameters, Usage, Options – Altera Quartus II Scripting User Manual

Page 361: Description, Remove_all_parameters –231

Advertising
background image

Chapter 3: Tcl Packages & Commands

3–231

project

© July 2013

Altera Corporation

Quartus II Scripting Reference Manual

remove_all_parameters

Usage

remove_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

Removes all matching parameters.

The "-name" option is not case sensitive. The "-to" option is case sensitive.

If the "-to" argument is specified, the function removes the parameters from the current entity. The
parameters are removed from the PARAMETERS section of the entity. Otherwise, the function removes the
project-wide default parameters obtained from the DEFAULT_PARAMETERS section.

This Tcl command filters the parameter data found in the Quartus II Settings File (.qsf) and removes 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:
remove_all_parameters -name * -to a[0]

# To match all indices of bus "a", type:
remove_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:

remove_all_parameters -name * -to "a[escape_brackets \[]\[0-2\][escape_brackets \]]"

For more information about escaping square brackets, type "escape_brackets -h".

Use the "-entity" option to remove the parameters from the specified entity. If the "-entity" option is not
specified, the value for the FOCUS_ENTITY_NAME assignment is used. If the FOCUS_ENTITY_NAME
value is not found, the revision name is used.

The parameters removed by using this Tcl command are not saved to the Quartus II Settings File (.qsf)
unless you explicitly call one of the following two Tcl commands:

export_assignments

project_close (unless "-dont_export_assignments" is specified)

Advertising