Get a list of Configurable Report objects
Syntax
get_report_configs [‑regexp] [‑nocase] [‑filter <arg>] [‑of_objects <args>]
[‑quiet] [‑verbose] [<patterns>]
Returns
List of Configurable Report objects.
Usage
Name | Description |
---|---|
[-regexp]
|
Patterns are full regular expressions |
[-nocase]
|
Perform case-insensitive matching (valid only when -regexp specified) |
[-filter]
|
Filter list with expression |
[-of_objects]
|
Get 'report' objects of these types: 'run'. |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match report names against patterns Default: * |
Description
Returns a list of report objects created by the create_report_config
command.
This command returns the list of report objects matching the search pattern and filters, or returns an error if it fails.
Arguments
-regexp
- (Optional) Specifies that the search <patterns> are written as regular expressions. Both search <patterns> and -filter
expressions must be written as regular expressions when this argument is used. Xilinx® regular expression Tcl commands are always anchored to the start of the search string. You can add ".*" to the beginning or end of a search string to widen the search to include a substring. See http://perldoc.perl.org/perlre.html for help with regular expression syntax.
regexp
is not anchored, and works as a standard Tcl command. For more information refer to http://www.tcl.tk/man/tcl8.5/TclCmd/regexp.htm.
-nocase
- (Optional) Perform case-insensitive matching when a pattern has been specified. This argument applies to the use of -regexp
only.
-filter
<args> - (Optional) Filter the results list with the specified expression. The -filter
argument filters the list of objects returned by get_report_configs
based on property values on the objects. You can find the properties on an object with the report_property
or list_property
commands. In the case of the "report" object, "REPORT_TYPE", "RUN_STEP" and "STATE" are some of the properties that can be used to filter results.
get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}
bool
) type properties can be directly evaluated in filter expressions as true or not true: -filter {IS_PRIMITIVE && !IS_LOC_FIXED}
-of_objects <arg>
- (Optional) Get the reports associated with the specified design run objects as returned by the get_runs
command.
-quiet
- (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
-verbose
- (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config
command.<patterns> - (Optional) Match report objects against the specified patterns. The default pattern is the wildcard '*' which gets a list of all report objects in the project.
Examples
The following example gets all of the report objects in the current project:
get_report_configs
The following example gets all of the report objects in the current project that are associated with the opt_design step:
get_report_configs -filter {RUN_STEP == opt_design}