Intel® Quartus® Prime Pro Edition User Guide: Design Optimization

ID 683641
Date 4/03/2023

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

Document Table of Contents Project Handle Properties

The main purpose of Project Handle objects is to configure, launch, and manage a connection to a single project compilation database.

Table 29.  Project Handle Properties
Property Name Property Type Property Description Default Value Read-Only Comments
qpf_path String (must be a valid path to a .qpf file) Project file corresponding to the project and database to open and interface with N/A
project_directory String Directory name of the project file you interface with N/A True Derived from the qpf_path value
project_name String Base name of the project file being interfaced with N/A True Derived from the qpf_path value
revision_name String Revision name to specify N/A If unspecified, Exploration Dashboard assumes that the revision name is the default revision name for the project. This updates when you set the qpf_path property.
interface_exe Either: quartus_sta, quartus_sh, or quartus_cdb Name of the Intel Quartus Prime software executable that you use to open and interact with the project database quartus_sta You can only modify this while the project is disconnected (that is, the connected parameter is false). The most significant difference between the values of interface_exe is the availability of Tcl packages for use when issuing commands.
local Boolean Flag indicating that the Intel Quartus Prime software process should be launched on the same host as Exploration Dashboard (ignoring SSH/LSF) False
connected Boolean Reflects the state of the communication channel after the launch_connection or disconnect methods complete successfully. False True
groups List of Project Group IDs Set of groups to which the project belongs. N/A A project can be in any number of groups. Each group ID present in a project’s groups property corresponds to a group object that is guaranteed to have that project’s ID present in its projects property . Project groups properties are kept consistent with group projects properties).
Note: All projects must be in at least one group. Running sanitize_workspace creates and places all ungrouped projects into a default group.