qed::import_report_panel_names (::quartus::qed)

Tcl Package and Version

Syntax

qed::import_report_panel_names [-h | -help] [-long_help] [-async] [-folders <folders> ] [-regexp_match <regexp_match> ] [-string_match <string_match> ] [-timeout <timeout> ] <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)

-folders <folders>

List of top-level folders to import panels from

-regexp_match <regexp_match>

Regexp to match against remote panel names before returning them

-string_match <string_match>

Pattern to match against remote panel names before returning them

-timeout <timeout>

Optional timeout for waiting for a return value in ms (default = 0 = no timeout)

<object>

Identifier associated with the object, must be unique

Description

Imports a list of report panel names from a project or projects in
a project group.

By default, all report panel names are imported.

The "-string_match" option limits the panel names that are imported to
panel names that match a Tcl glob-style pattern.

The "-regexp_match" option limits the panel names that are imported to
panel names that match the given regular expression. Enclose the
regular expression in curly braces.

The "-folders" option limits the panel names that are imported to
panel names that are contained in the given top-level folder names.
Top-level folder names correspond to the folder names in the
compilation report, such as Synthesis, Fitter, and Timing Analyzer.
Specify multiple folder names as a Tcl list, such as
{ Synthesis Fitter "Timing Analyzer" }.

When you call import_report_panel_names with a project object, the
command returns a list of report panel names that match the filters
or folder names. Any errors that occur are returned with standard
Tcl error semantics.

Before you import a report panel, you must have successfully used
the "qed::launch_connection" command to initiate background instances of
the Quartus Prime 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_names project_A

Return Value

Code Name

Code

String Return

TCL_OK

0

INFO: Operation successful

Tcl Package and Version	Belongs to ::quartus::qed 1.0
Syntax	`qed::import_report_panel_names [-h \| -help] [-long_help]` `[-async]` `[-folders` <folders> `]` `[-regexp_match` <regexp_match> `]` `[-string_match` <string_match> `]` `[-timeout` <timeout> `]` <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)
	`-folders` <folders>		List of top-level folders to import panels from
	`-regexp_match` <regexp_match>		Regexp to match against remote panel names before returning them
	`-string_match` <string_match>		Pattern to match against remote panel names before returning them
	`-timeout` <timeout>		Optional timeout for waiting for a return value in ms (default = 0 = no timeout)
	<object>		Identifier associated with the object, must be unique
Description	Imports a list of report panel names from a project or projects in a project group. By default, all report panel names are imported. The "-string_match" option limits the panel names that are imported to panel names that match a Tcl glob-style pattern. The "-regexp_match" option limits the panel names that are imported to panel names that match the given regular expression. Enclose the regular expression in curly braces. The "-folders" option limits the panel names that are imported to panel names that are contained in the given top-level folder names. Top-level folder names correspond to the folder names in the compilation report, such as Synthesis, Fitter, and Timing Analyzer. Specify multiple folder names as a Tcl list, such as { Synthesis Fitter "Timing Analyzer" }. When you call import_report_panel_names with a project object, the command returns a list of report panel names that match the filters or folder names. Any errors that occur are returned with standard Tcl error semantics. Before you import a report panel, you must have successfully used the "qed::launch_connection" command to initiate background instances of the Quartus Prime 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_names project_A
Return Value	Code Name	Code	String Return
TCL_OK	0	INFO: Operation successful