Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/13/2021
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

3.1.29.41. remove_from_collection (::quartus::sta)

The following table displays information for the remove_from_collection Tcl command:

Tcl Package and Version

Belongs to ::quartus::sta

Syntax remove_from_collection [-h | -help] [-long_help] <base_collection> <items_to_remove>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
<base_collection> Collection to remove items from
<items_to_remove> Items to be removed from base_collection
Description
This command takes two collections and returns a new
collection that is the difference of the two,
effectively the second collection subtracted from the
first collection. The second collection can be a
string, but the first has to be previously-created
collection: either by passing any of the "get_"
functions directly, or by passing a variable that
contains a collection (see code examples for
this command). If a collection is used for the 
second argument, the types in the second collection 
must be the same as or a subset of the types in the 
first collection.

If the first collection consists of keepers, the second 
collection can only consist of keepers, registers or ports. 
If the first collection consists of partitions, the second 
collection can only consist of partitions or cells. If 
the first collection consists of nodes, the second collection 
can only consist of nodes, keepers, registers, ports, pins, 
nets or combinational nodes.
Example Usage
set a_keeprs [get_keepers a*]
set a1_regs [get_registers a1*]

set keeprs_without_a1 [remove_from_collection $a_keeprs $a1_regs]

#or:
set keeprs_without_a1 [remove_from_collection $a_keeprs [get_registers a1*]]

#or even:
set keeprs_without_a1 [remove_from_collection $a_keeprs a1*]

# - note that the last statement will actually remove all keepers with name a1*
#   not only registers! (will remove IOs with name a1*, if any)

# Get the first 100 nodes in the collection.
query_collection $keeprs_without_a1 -limit 100
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Cannot find specified collection. Specify an existing collection.

Did you find the information on this page useful?

Characters remaining:

Feedback Message