Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 4/03/2023
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.28. qed::pop_from_property (::quartus::qed)

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

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::pop_from_property [-h | -help] [-long_help] -property <property> -value <value> [-all] [-allow_missing] <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
-all Flag indicating that multiple instances of the value should all be removed (default: only the first is removed)
-allow_missing Flag to bypass the usual error if the value wasn't already present in the property's value
<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, removing the value from the returned list,
then calling "qed::set_property" to update the entire list value.

The "-all" argument removes all instances of the value from the list. Without
this flag, only the first instance of a potentially repeated value will be
removed.

The "-allow_missing" argument bypasses the error which is normally thrown
if the value to pop is not present in the list.

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