Quartus® Prime Pro Edition User Guide: Scripting

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

4.1.31.10. qed::create_object (::quartus::qed)

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

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::create_object [-h | -help] [-long_help] -type <project|group> [-user_data <user_data> ] [-groups <groups> ] [-qpf_path <qpf_path> ] [-revision <revision> ] [-projects <projects> ] [-default_group_id <default_group_id> ] [ <id> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-type <project|group> 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)
<id> Identifier associated with the object, must be unique
Description
Creates project or project group objects. The command returns the
ID of the newly created object.

The "-type" option is required, and must specify one of project
or group.

Other supported options depend on the type of object you are
creating. The options correspond to property names that are valid
for the type of object you are creating.
Example Usage
    qed::create_object -type project project_A     -qpf_path /path/to/project_A/project.qpf -revision project_A
    qed::create_object -type project project_B     -qpf_path /path/to/project_B/project.qpf -revision project_B
    qed::create_object -type group   both_projects -projects {project_A project_B}
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful