Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 4/01/2024
Public
Document Table of Contents

4.1.31.22. 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|workspace> ] [-user_data <user_data> ] [-groups <groups> ] [-qpf_path <qpf_path> ] [-revision <revision> ] [-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|workspace> Type of QED Workspace object
-user_data <user_data> Freetext field to store any interesting metadata on the object. Use qed::set_user_data and qed::get_user_data to interact with the value as a dict instead of a string.
-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)
-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
Returns a Tcl list of project or project group objects that match
the options you specify.

If no objects match, the command returns an empty list.
Example Usage
    qed::get_objects -type project project_A  -user_data "hello world!"     -qpf_path /path/to/project_A/project.qpf -revision project_A
    qed::get_objects -type group   my_group   -user_data "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 $user_data}]
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful