Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/12/2022
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.29.13. qed::get_objects (::quartus::qed)

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

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::get_objects [-h | -help] [-long_help] [-type <project|group> ] [-comment <comment> ] [-groups <groups> ] [-qpf_path <qpf_path> ] [-revision <revision> ] [-compute_spec <ssh|arc|local|lsf> ] [-exe <quartus_sta|quartus_cdb> ] [-exe_options <exe_options> ] [-projects <projects> ] [-default_group_id <default_group_id> ] [-checks <checks> ] [ <id> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-type <project|group> Type of QED Workspace object
-comment <comment> Freetext field to store any interesting metadata on the object
-groups <groups> Set of group IDs this project is a member of. (Valid only for -type project)
-qpf_path <qpf_path> Full path to a .qpf file to open. (Valid only for -type project)
-revision <revision> Name of the revision to open. (Valid only for -type project)
-compute_spec <ssh|arc|local|lsf> Flag indicating the compute type use launch the project-accessing process. (Valid only for -type compute_spec)
-exe <quartus_sta|quartus_cdb> Executable to open the project with. Dictates the packages and commands that will be available to run. (Valid only for -type compute_spec)
-exe_options <exe_options> Options to pass to executable.
-projects <projects> Set of projects belonging to the group. (Valid only for -type group)
-default_group_id <default_group_id> Identifier used for the 'default group' that's created to house ungrouped projects during sanitize_workspace. (Valid only for -type workspace)
-checks <checks> List of Tcl expressions that evaluate to true for objects to retrieve. Expressions may use properties as variables of the same name during the check.
<id> Identifier associated with the object, must be unique
Description
This command currently contains no help description.
Example Usage
    qed::get_objects -type project project_A  -comment "hello world!"     -qpf_path /path/to/project_A/project.qpf -revision project_A
    qed::get_objects -type group   my_group   -comment "hello neighbour!" -projects {project_A}

    # Returns: {project_A my_group}
    qed::get_objects

    # Returns: {project_A}
    qed::get_objects -type project

    # Returns: {my_group}
    qed::get_objects -projects project_A

    # Returns: {project_A my_group}
    qed::get_objects -checks [list {"hello" in $comment}]
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful