Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/13/2021
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

3.1.26.7. get_report_panel_column_index (::quartus::report)

The following table displays information for the get_report_panel_column_index Tcl command:

Tcl Package and Version

Belongs to ::quartus::report

Syntax get_report_panel_column_index [-h | -help] [-long_help] [-id <table_id> ] [-name <table_name> ] <col_name>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-id <table_id> Id of panel from which to get column index
-name <table_name> Name of panel from which to get column index
<col_name> Column name
Description
Gets the column index of the specified panel column name.

Column name refers to the specified name in the header row. The 
column index is a non-negative integer for an existing column. The 
column index is -1 if the column name is not found in the panel.

Using the column index and panel id provides faster data access 
than using column name and panel name.

Column indices and panel ids that you have cached may become 
outdated or invalid if the report is unloaded or reloaded. 
This error occurs after compilation or with calls to the 
"project_close", "unload_report", and "load_report" commands.

Column and panel names support wildcards.

The table of contents portion of the Compilation Report
window shows short panel names for better readability.
However, the panel name used by this command is the full
panel name as shown in the right-hand side frame of the
Compilation Report window or the .rpt file of the
corresponding command-line executable. For example, the
table of content shows the path "Analysis and Synthesis||Summary".
However, the corresponding full path used by this Tcl command
is "Analysis and Synthesis||Analysis and Synthesis Summary".
Example Usage
load_package report
project_open chiptrip
load_report

# Set panel name and id
set panel  {*Input Pins}
set id     [get_report_panel_id $panel]

# Set column name and index
set cname  {Pin #}
set cindex [get_report_panel_column_index -id $id $cname]

# Get data out of the specified panel
set clock  [get_report_panel_data -id $id -row_name clk1 -col $cindex]
set enable [get_report_panel_data -id $id -row_name enable -col $cindex]

# Output results
puts "$cname of clock: $clock"
puts "$cname of enable: $enable"

unload_report
project_close
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful

Did you find the information on this page useful?

Characters remaining:

Feedback Message