qed::get_project_report_panel_names (::quartus::qed)
The following table displays information for the qed::get_project_report_panel_names Tcl command:
Tcl Package and Version |
Belongs to ::quartus::qed 1.0 |
|||
Syntax | qed::get_project_report_panel_names [-h | -help] [-long_help] [-include_generated_panels] [-regexp_match <regexp_match> ] [-string_match <string_match> ] <object> | |||
Arguments | -h | -help | Short help | ||
-long_help | Long help with examples and possible return values | |||
-include_generated_panels | Flag to include QED-generated panels in the output | |||
-regexp_match <regexp_match> | Regex to filter all panels, in the style of the \[regexp\] command | |||
-string_match <string_match> | Pattern to filter all panels, in the style of the \[string match\] command | |||
<object> | Identifier associated with the object, must be unique | |||
Description |
Returns a multi-level Tcl dict of report panel names associated with the projects of the given group object. In the event that certain project report panels across the group only differ by seed-dependent values (e.g. slack values, Design Assistant violation counts, etc.) they will be grouped together in the returned dictionary based on a sanitized version of the panel names. The primary keys in the returned dictionary correspond to these sanitized names, and each sanitized name maps to a sub-dictionary where the key is a project that maps to the original, un-sanitized name of the panel associated with that project. If a panel was imported or generated on some of the group's projects but not others, only the projects with that panel will appear in the values associated with that panel's name. Each un-sanitized panel name associated with a project can be passed to the "qed::get_object_report_panel_contents" command alongside the project ID the panel name maps to. There are several ways to control the panel names which are returned by this command. The "-string_match" option supports Tcl glob-style pattern matching. The "-regexp_match" option supports Tcl regexp pattern matching. You should enclose your regular expression in curly braces. The "-include_generated_panels" option control whether report panels that were generated by the Quartus Exploration Dashboard are included in the list. If you call the "qed::get_project_report_panel_names" command, and do not specify the "-include_generated_panels" option, the dict returned includes only report panels that were imported from each project. |
|||
Example Usage |
qed::create_object -type project project_A -qpf_path /file/path/to/A/project.qpf qed::launch_connection project_A -open_project qed::create_object -type project project_B -qpf_path /file/path/to/B/project.qpf qed::launch_connection project_B -open_project qed::create_object -type group both_projects -projects {project_A project_B} qed::import_report_panel both_projects -panel_name "Timing Analyzer||Setup Summary" qed::import_report_panel project_A -panel_name "Timing Analyzer||Hold Summary" # Returns: # { # "Timing Analyzer||Setup Summary" { # project_A "Timing Analyzer||Setup Summary" # project_B "Timing Analyzer||Setup Summary" # } # "Timing Analyzer||Hold Summary" { # project_B "Timing Analyzer||Hold Summary" # } # } qed::get_project_report_panel_names both_projects |
|||
Return Value | Code Name | Code | String Return | |
TCL_OK | 0 | INFO: Operation successful |