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.1. add_row_to_table (::quartus::report)

The following table displays information for the add_row_to_table Tcl command:

Tcl Package and Version

Belongs to ::quartus::report

Syntax add_row_to_table [-h | -help] [-long_help] [-id <table_id> ] [-name <table_name> ] <row>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-id <table_id> Id of table to update
-name <table_name> Name of table to update
<row> Tcl list of strings to add to table
Description
Adds the list of strings to the table as a row.

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 gets 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 content portion of the UI 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
UI 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 {Fitter||Fitter Settings}
set id [get_report_panel_id $panel]

if {$id != -1} {
    # If panel exists, add a row to it
    add_row_to_table -id $id {{New Field} Yes No}
    # Save the changes to the report database
    save_report_database
} else {
    # Otherwise print an error message
    puts "Error: Table $panel does not exist."
}

unload_report
project_close
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Number of elements conflict. The number of elements in the added row must be <string>.
TCL_ERROR 1 ERROR: Illegal color: <string>. Specify a color that is currently supported by add_row_to_table.
TCL_ERROR 1 ERROR: You specified <string> colors for the -<string> option. However, you must specify <string> colors to match the number of elements specified for the <<string>> argument.
TCL_ERROR 1 ERROR: Value specified for -<string> option is not a valid Tcl list: <string>. Specify a valid Tcl list.
TCL_ERROR 1 ERROR: You must open a project before you can use this command.
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.
TCL_ERROR 1 ERROR: Value specified for <row> is not a valid Tcl list: <string>. Specify <row> as a valid Tcl list.
TCL_ERROR 1 ERROR: add_row_to_table command is not allowed for this report panel. You cannot add rows to this report panel.

Did you find the information on this page useful?