Get a list of example designs
Syntax
get_example_designs [‑regexp] [‑nocase] [‑filter <arg>] [‑quiet] [‑verbose]
[<patterns>...]Returns
List of design objects.
Usage
| Name | Description |
|---|---|
[-regexp]
|
Patterns are full regular expressions |
[-nocase]
|
Perform case-insensitive matching |
[-filter]
|
Filter list with expression |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
The patterns to match against Default: * Values: The default search pattern is the wildcard *, or .* when -regexp is specified. |
Categories
Description
The command returns a list of example designs available in the current release of the Vivado® Design Suite, or returns an error if it fails.
Example designs can be opened, or instantiated into the Vivado Design Suite, onto specific target hardware devices or boards.
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.
-nocase - (Optional) Perform case-insensitive matching when a pattern has been specified. This argument applies to the use of -regexp only.
-filter <args> - (Optional) Filter the results list with the specified expression. The -filter argument filters the list of objects returned by get_example_designs based on property values on the designs. You can find the properties on an object with the report_property or list_property commands. In the case of the "example design" object, "NAME", "SUPPORTED_BOARDS" and "SUPPORTED_PARTS" are some 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}
-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 example designs against the specified patterns. The default pattern is the wildcard '*' which gets a list of all supported example designs.
Examples
The following example returns reports the properties of each of the example designs in the current release:
foreach x [get_example_designs] {
puts "********* Design $x **************"
report_property -all $x}