Get a list of children HDL scopes of a scope
Syntax
get_scopes [‑filter <arg>] [‑regexp] [‑nocase] [‑r] [‑quiet] [‑verbose]
[<patterns>...]
Returns
Returns HDL scope objects from the given arguments.
Usage
Name | Description |
---|---|
[-filter]
|
filters <patterns> according to the specified property-matching expressions |
[-regexp]
|
interprets <patterns> using regular expressions |
[-nocase]
|
only when regexp is used, performs a case insensitive match |
[-r]
|
only when a glob or regular expression pattern is used, descends recursively into children scopes to search for <patterns> |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
the pattern strings to search for scopes. Default: * (all children scopes) |
Categories
Description
Get a list of children HDL scopes of the current or specified scope
This command returns a list of scope objects, or returns an error.
Arguments
-r
- (Optional) Recursively return the children scopes of the current scope.
-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 returned results list with the specified expression. The -filter
argument filters the list of objects returned by get_scopes
based on property values on the scope objects. You can find the properties on an object with the report_property
or list_property
commands.
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 Scope objects against the specified patterns. The default pattern is the wildcard '*' which gets a list of all Scopes that are children of the current scope. More than one pattern can be specified to find multiple Scope objects based on different search criteria.
Examples
The following example recursively returns all of the children scopes of the specified scope:
get_scopes -r /testbench/dut