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.3. delete_report_panel (::quartus::report)

The following table displays information for the delete_report_panel Tcl command:

Tcl Package and Version

Belongs to ::quartus::report

Syntax delete_report_panel [-h | -help] [-long_help] [-id <panel_id> ] [-name <panel_name> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-id <panel_id> Id of panel to delete
-name <panel_name> Name of panel to delete
Description

Deletes the report panel with the specified id or name. The panel can either be a report table or report folder. 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
load_package report
project_open chiptrip
load_report

# Set table name and id
set table    "Fitter||My Table"
set table_id [get_report_panel_id $table]

# Delete the table if the it already exists
if {$table_id != -1} {
    delete_report_panel -id $table_id
}

# Re-create the table
create_report_panel -table $table
add_row_to_table -name $table {{Name} {Value}}
add_row_to_table -name $table {{Number of Registers} {100}}

# This time, use table name instead of table id to delete it.
delete_report_panel -name $table

# Now, delete a folder
set folder    "My Folder"
set folder_id [get_report_panel_id $folder]

# Delete it if the specified folder already exists
if {$folder_id != -1} {
    delete_report_panel -id $folder_id
}

# Save the changes to the report database
save_report_database

unload_report
project_close
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Found conflicting panel options. Specify only one of the options: -name or -id.
TCL_ERROR 1 ERROR: The delete_report_panel command is not allowed for this report panel. You cannot delete a report panel folder.
TCL_ERROR 1 ERROR: Illegal panel id: <string>. Specify a legal panel id.
TCL_ERROR 1 ERROR: You must open a project before you can use this command.
TCL_ERROR 1 ERROR: Specify one of the options: -name or -id.
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.

Did you find the information on this page useful?

Characters remaining:

Feedback Message