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.5. get_number_of_columns (::quartus::report)

The following table displays information for the get_number_of_columns Tcl command:

Tcl Package and Version

Belongs to ::quartus::report

Syntax get_number_of_columns [-h | -help] [-long_help] [-id <table_id> ] [-name <table_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 data
-name <table_name> Name of panel from which to get data
Description

Returns the number of columns for the specified panel. Using the panel id provides faster data access than using the panel name. 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. 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 contents 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
## Loop through a panel row and print out all its element information

load_package report
project_open chiptrip
load_report

# Set panel name and id
set panel   {*Input Pins}
set id      [get_report_panel_id $panel]
        if {$id == -1} {
	error( "Panel not found")
}

# Get the number of columns
set col_cnt [get_number_of_columns -id $id]

# Set row name and get row index
set rname   {*clk1*}
set rindex  [get_report_panel_row_index -id $id $rname]
set rname   [get_report_panel_data -row $rindex -col 0 -id $id]

puts "\[Input Pins - $rname\]"
for {set i 1} {$i < $col_cnt} {incr i} {
    set    result "[get_report_panel_data -row 0 -col $i -id $id]: "
    append result [get_report_panel_data -row $rindex -col $i -id $id]
    puts   $result
}

unload_report
project_close
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_OK 0 INFO: Report automatically reloaded because it was not up-to-date after use of Tcl command execute_flow or execute_module (which belong to ::quartus::flow package). No action is required.
TCL_ERROR 1 ERROR: Can't find the top-level panel. Make sure the loaded report is not empty. You can run a successful compilation to rebuild the report.
TCL_ERROR 1 ERROR: Can't find panel: <string>. Specify an existing report panel name.
TCL_ERROR 1 ERROR: Report not loaded for revision name: <string>. Type load_report to load the report.
TCL_ERROR 1 ERROR: Can't access report panel. Use this command only for report panels with rows or columns.

Did you find the information on this page useful?

Characters remaining:

Feedback Message