qed::set_properties (::quartus::qed)
The following table displays information for the qed::set_properties Tcl command:
Tcl Package and Version |
Belongs to ::quartus::qed 1.0 |
|||
Syntax | qed::set_properties [-h | -help] [-long_help] [-user_data <user_data> ] [-groups <groups> ] [-qpf_path <qpf_path> ] [-revision <revision> ] [-projects <projects> ] [-default_group_id <default_group_id> ] [-id <id> ] [-from_dict <from_dict> ] <object> | |||
Arguments | -h | -help | Short help | ||
-long_help | Long help with examples and possible return values | |||
-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 <id> | New identifier to associate with the object, must be unique | |||
-from_dict <from_dict> | Dictionary used to set the properties (key = property name, value = property value) | |||
<object> | Identifier associated with the object, must be unique | |||
Description |
Allows you to modify multiple properties of an object, with a single command, after the object has been created. You must specify the multiple properties and new values in a Tcl dict. Valid property and value strings depend on the type of object you are updating. Calling the "qed::set_properties" command with a dict of size 1 is equivalent to calling the "qed::set_property" command. The command returns a Tcl error if any of the dictionary keys do not exist as properties of the given object. |
|||
Example Usage |
qed::create_object -type project project_A qed::set_properties project_a -qpf_path /path/to/project_B/project.qpf -revision project_B |
|||
Return Value | Code Name | Code | String Return | |
TCL_OK | 0 | INFO: Operation successful |