Get registered simulators
Syntax
get_simulators [‑regexp] [‑nocase] [‑filter <arg>] [‑quiet] [‑verbose]
[<patterns>]Usage
| Name | Description |
|---|---|
[-regexp]
|
Patterns are full regular expressions |
[-nocase]
|
Perform case-insensitive matching (valid only when -regexp specified) |
[-filter]
|
Filter list with expression |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match simulator names against patterns Default: * |
Categories
Description
Get the list of simulators registered for use with the Vivado Design Suite unified simulation environment.
The Vivado Design Suite comes with some simulators pre-registered for use with the unified simulation environment. You can also register your own third-party simulators using the register_simulator command.
This command returns the names of registered simulators, or returns an error if it fails.
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_simulators based on the properties on the registered simulators. You can find the properties on a registered simulator object with the report_property or list_property commands. In the case of the "simulator" object, "NAME", "DESCRIPTION", and "TCLPROC.BOOTSTRAP" 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 available simulators against the specified patterns. The default pattern is the wildcard '*' which gets all registered simulators.
Example
get_simulators