qed::open_project (::quartus::qed)

Tcl Package and Version

Syntax

qed::open_project [-h | -help] [-long_help] [-force_open] [-load_db_state] [-async] [-timeout <timeout> ] <object>

Arguments

-h | -help

Short help

-long_help

Long help with examples and possible return values

-force_open

Flag to use -force when running project_open on the remote side

-load_db_state

Flag to load the necessary compilation database state for the accessor executable once the connection is established and the project is open. For example, if the accessor executable is "quartus_sta", this initializes the timing netlist

-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)

-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

Use the "-timeout" option to specify the maximum time to wait for
the background instance of the Quartus Prime software to open the project.
The timeout value is specified in seconds, and its default is 0, which
means to wait forever. Specifying "-timeout 0" is equivalent to
not using the "-timeout" option.

Use the "-load_db_state" option to prepare the project for deeper
analysis after it opens. The specific operations performed will depend
on the executable used to access the project. For example, if the
project is accessed with "quartus_sta", timing analysis preparation
follows the initialization procedure in the Quartus Prime Timing
Analyzer: creating the timing netlist, reading any SDC files, and
updating the timing netlist.

The "-async" option causes the command to returns a token for use
with the "get_return_value" command. By default the command will
wait, or block, until the background instances of the Quartus Prime
software have started, and any project opening or timing initialization
options have completed.

When you call "qed::open_project" with a project group object without
specifying the "-async" option, the command returns a Tcl dict where
keys are IDs of the projects in the project group, and the values are
two-element lists of the form { <code> <result> }. If the <code> value
is 1, the "open_project" command received an error opening the project
or initializing the executable state. When the <code> value is 1,
the <result> contains the received error message. If the <code> value is 0,
the "open_project" command was successful for the project, and
the <result> value contains the return value of whatever parts of the
initialization flow you have specified.

Example Usage

    qed::create_object -type project project_A -qpf_path /file/path/to/project.qpf

    qed::launch_connection project_A
    qed::open_project 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::open_project [-h \| -help] [-long_help]` `[-force_open]` `[-load_db_state]` `[-async]` `[-timeout` <timeout> `]` <object>
Arguments	`-h \| -help`		Short help
	`-long_help`		Long help with examples and possible return values
	`-force_open`		Flag to use -force when running project_open on the remote side
	`-load_db_state`		Flag to load the necessary compilation database state for the accessor executable once the connection is established and the project is open. For example, if the accessor executable is "quartus_sta", this initializes the timing netlist
	`-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)
	`-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	Use the "-timeout" option to specify the maximum time to wait for the background instance of the Quartus Prime software to open the project. The timeout value is specified in seconds, and its default is 0, which means to wait forever. Specifying "-timeout 0" is equivalent to not using the "-timeout" option. Use the "-load_db_state" option to prepare the project for deeper analysis after it opens. The specific operations performed will depend on the executable used to access the project. For example, if the project is accessed with "quartus_sta", timing analysis preparation follows the initialization procedure in the Quartus Prime Timing Analyzer: creating the timing netlist, reading any SDC files, and updating the timing netlist. The "-async" option causes the command to returns a token for use with the "get_return_value" command. By default the command will wait, or block, until the background instances of the Quartus Prime software have started, and any project opening or timing initialization options have completed. When you call "qed::open_project" with a project group object without specifying the "-async" option, the command returns a Tcl dict where keys are IDs of the projects in the project group, and the values are two-element lists of the form { <code> <result> }. If the <code> value is 1, the "open_project" command received an error opening the project or initializing the executable state. When the <code> value is 1, the <result> contains the received error message. If the <code> value is 0, the "open_project" command was successful for the project, and the <result> value contains the return value of whatever parts of the initialization flow you have specified.
Example Usage	qed::create_object -type project project_A -qpf_path /file/path/to/project.qpf qed::launch_connection project_A qed::open_project project_A
Return Value	Code Name	Code	String Return
TCL_OK	0	INFO: Operation successful