Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 10/04/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.2. create_report_panel (::quartus::report)

The following table displays information for the create_report_panel Tcl command:

Tcl Package and Version

Belongs to ::quartus::report

Syntax create_report_panel [-h | -help] [-long_help] [-folder] [-table] <panel_name>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-folder Option to create folder
-table Option to create table
<panel_name> Name of the panel to create
Description

Creates a new report panel with the specified name. If -table option is specified, a table is created. If -folder option is specified, a folder is created. The name must be the full path to the new report panel, such as "Fitter||My Table". If the specified panel is created successfully, the corresponding panel id is returned. 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 folder name and id
set folder    "My Folder"
set folder_id [get_report_panel_id $folder]

# Check if specified folder exists. If not, create it.
if {$folder_id == -1} {
    set folder_id [create_report_panel -folder $folder]
}

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

# Check if specified table exists. If so, delete it.
if {$table_id != -1} {
    delete_report_panel -id $table_id
}

# Create the specified table and get its id
set table_id [create_report_panel -table $table]

# Add Timing Analyzer Summary to the table
add_row_to_table -id $table_id {{Name} {Value}}
add_row_to_table -id $table_id {{Number of Registers} {100}}

# 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: Report folder <string> already exists -- specify a different report folder name.
TCL_ERROR 1 ERROR: Can't find folder: <string>. Specify an existing report folder name.
TCL_ERROR 1 ERROR: Illegal color: <string>. Specify a color that is currently supported by add_row_to_table.
TCL_ERROR 1 ERROR: The input report object is not a table to be the master table of master details object
TCL_ERROR 1 ERROR: The parent folder is not master details type <string>.
TCL_ERROR 1 ERROR: The master details object already has the master table
TCL_ERROR 1 ERROR: Options -table, -tcl_table and -folder are mutually exclusive -- specify only one of the options.
TCL_ERROR 1 ERROR: You must open a project before you can use this command.
TCL_ERROR 1 ERROR: Report object is not a folder: <string>. Specify an existing report folder name.
TCL_ERROR 1 ERROR: Specify one of the options: -<string> or -<string>.
TCL_ERROR 1 ERROR: Report not loaded for revision name: <string>. Type load_report to load the report.
TCL_ERROR 1 ERROR: Report panel already exists: <string>. Specify a different report panel name.

Did you find the information on this page useful?

Characters remaining:

Feedback Message