Quartus® Prime Pro Edition User Guide: Scripting

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

4.1.31.38. qed::push_to_property (::quartus::qed)

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

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::push_to_property [-h | -help] [-long_help] -property <property> -value <value> [-unique] <object>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-property <property> Name of the property to set
-value <value> Value to set the property to
-unique Flag indicating that the value shouldn't be appended if already present in the property
<object> Identifier associated with the object, must be unique
Description
Specialized version of the "qed::set_property" command to modify
properties that have list values.

It is equivalent to retrieving the existing property value with the
"qed::get_property" command, appending the value to the returned list,
then calling "qed::set_property" to update the entire list value.

The "-unique" argument prevents the value from being added to the list
if it is already present. Without this flag, the value will be added
to the end of the list regardless of the other values already present.

The command returns the updated value of the property.

The command returns a Tcl error if the given property does not exist.
Example Usage
    qed::create_object -type group   group_one
    qed::create_object -type group   group_two

    # Result: project_A is in groups {group_one}
    qed::create_object -type project project_A -groups {group_one}

    # Result: project_A is in groups {group_one group_two}
    qed::push_to_property project_A -property groups -value group_two

    # Result: project_A is in groups {group_two}
    qed::pop_from_property project_A -property groups -value group_one
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful