Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/04/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.30.35. qed::load_db_state (::quartus::qed)

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

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::load_db_state [-h | -help] [-long_help] [-async] [-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)
-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
Prepares an opened project for deeper analysis. 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 Pro Timing Analyzer: creating the timing netlist, reading
any SDC files, and updating the timing netlist.

If the opened project does not have a completed compilation database,
this will return an error.

Use the "-timeout" option to specify the maximum time to wait for
the background instance of the Quartus Prime Pro software to initialize the
executable state on an opened 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.

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::load_db_state" 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 "load_db_state" command received an error loading the compilation
database state. When the <code> value is 1, the <result> contains
the received error message. If the <code> value is 0, the
"load_db_state" command was successful for the project, and
the <result> value contains a message describing that the process succeeded.
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
    qed::load_db_state project_A
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful