write_report_panel (::quartus::report)

The following table displays information for the write_report_panel Tcl command:

Tcl Package and Version

Belongs to ::quartus::report 1.0

Syntax write_report_panel [-h | -help] [-long_help] -file <output file name> [-html] [-id <table_id> ] [-name <table_name> ] [-xml] [ <name> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-file <output file name> Name of output file to be generated
-html Option to generate output file in HTML format
-id <table_id> id of panel from which to get data
-name <table_name> Name of panel from which to get data
-xml Option to generate output file in XML format
<name> Name of panel from which to get data
Description
Writes data from the specified report panel to the specified 
output file. If the "-html" option is specified, the output file 
is generated in HTML format. If the "-xml" option is specified,
the output file is generated in XML format. Otherwise, the output
file is generated in ASCII format.

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 report database and write Timing Analyzer Summary
## panel to file in HTML format

load_package report
project_open chiptrip
load_report

# Set panel name and id
set panel "*Timing Analyzer Summary"
set id    [get_report_panel_id $panel]

# If the specified panel exists, write it to
# fmax.htm and fmax.xml.
# Otherwise, print out an error message
if {$id != -1} {
    write_report_panel -file fmax.htm -html -id $id
    write_report_panel -file fmax.xml -xml -id $id
} else {
    puts "Error: report panel could not be found."
}

unload_report
project_close
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_OK 0 INFO: Successfully generated HTML-Format Report File: <string>
TCL_OK 0 INFO: Successfully generated output file: <string>
TCL_OK 0 INFO: Successfully generated XML-Format Report File: <string>
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 create or overwrite file: <string>. Specify a file name that has write permission.
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.