Get a list of designs
Syntax
get_bd_designs [‑regexp] [‑filter <arg>] [‑of_objects <args>] [‑quiet]
[‑verbose] [<patterns>...]
Returns
List of design objects, "" if failed.
Usage
Name | Description |
---|---|
[-regexp]
|
Patterns are full regular expressions |
[-filter]
|
Filter list with expression |
[-of_objects]
|
Get diagrams of these bd-cells or pins or nets |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match engine names against patterns Default: * |
Categories
Description
Gets a list of IP subsystem designs open in the current project that match a specified search pattern. The default command gets a list of all open IP subsystem designs in the project.
get_*
commands return a container list of a single type of objects (e.g. cells, nets, pins, or ports). You can add new objects to the list (using lappend
for instance), but you can only add the same type of object that is currently in the list. Adding a different type of object, or string, to the list is not permitted and will result in a Tcl error.
Arguments
-regexp
- (Optional) Specifies that the search <patterns> are written as regular expressions. Both search <patterns> and -filter
expressions must be written as regular expressions when this argument is used. Xilinx® regular expression Tcl commands are always anchored to the start of the search string. You can add ".*" to the beginning or end of a search string to widen the search to include a substring. See http://perldoc.perl.org/perlre.html for help with regular expression syntax.
regexp
is not anchored, and works as a standard Tcl command. For more information refer to http://www.tcl.tk/man/tcl8.5/TclCmd/regexp.htm.
-filter
<args> - (Optional) Filter the results list with the specified expression. The -filter
argument filters the list of objects returned by get_bd_designs
based on property values on the block designs. You can find the properties on an object with the report_property
or list_property
commands. In the case of the "IP subsystem design" object, "NAME", and "FILE_NAME" are two of the properties that can be used to filter results.
get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}
bool
) type properties can be directly evaluated in filter expressions as true or not true: -filter {IS_PRIMITIVE && !IS_LOC_FIXED}
-of_objects
<args> - (Optional) Get the BD designs associated with the specified bd_cell, bd_pins, or bd_net objects.
-quiet
- (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
-verbose
- (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config
command.<patterns> - (Optional) Match designs against the specified patterns. The default pattern is the wildcard '*' which gets all IP subsystem designs. More than one pattern can be specified to find multiple designs based on different search criteria.
Examples
The following example gets all open IP subsystem designs in the current project:
get_bd_designs