Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 4/03/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

4.1.29.20. qed::import_report_panel (::quartus::qed)

The following table displays information for the qed::import_report_panel Tcl command:

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::import_report_panel [-h | -help] [-long_help] [-async] [-panel_name <panel_name> ] [-regexp_match <regexp_match> ] [-string_match <string_match> ] <object>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-async Flag indicating not to wait for any issued remote commands to complete. With this flag, the return value is a token that can be passed to qed::get_return_value. By default, the return value of the remote command is reproduced (including any errors)
-panel_name <panel_name> Name of the panel to retrieve
-regexp_match <regexp_match> Regex to match against all panels (first match is selected)
-string_match <string_match> Pattern to match against all panels (first match is selected)
<object> Identifier associated with the object, must be unique
Description
Imports a report panel from a project or projects in a project group
into the workspace.

When you use the "-panel_name" option, you must specify the path to the
report panel, separating report folder names with the "||" separator.
For example, the panel name of the RAM summary report panel is
"Fitter||Place Stage||Fitter RAM Summary".

The "-string_match" option supports Tcl glob-style pattern matching.
When multiple report panels match the "-string_match" pattern, only
the first matching report panel is imported.

The "-regexp_match" option supports Tcl regexp pattern matching. You
should enclose your regular expression in curly braces. When multiple
report panels match the "-regexp_match" option, only the first matching
report panel is imported.

Before you import a report panel, you must have successfully used
the "qed::launch_connection" command to initiate background instances of
the Quartus Prime Pro software, and you must have opened the projects.
Example Usage
    qed::create_object -type project project_A -qpf_path /file/path/to/project.qpf
    qed::launch_connection project_A -open_project
    qed::import_report_panel project_A -panel_name "Timing Analyzer||Setup Summary"
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful