get_wave_configs - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Gets the wave configs that match the given options

Syntax

get_wave_configs [‑regexp] [‑nocase] [‑filter <arg>] [‑quiet] [‑verbose]
    [<patterns>...]

Returns

Wave configs that match the given options.

Usage

Name Description
[-regexp] interprets <patterns> using regular expressions
[-nocase] only when regexp is used, performs a case insensitive match
[-filter] filters <patterns> according to the specified property-matching expressions
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<patterns>] the pattern strings to search for wave configuration names

Categories

Waveform

Description

Get the wave configuration objects that match the specified search options in the current simulation.

In the Vivado™ simulator GUI, you can work with a waveform to analyze your design and debug your code. The Wave Config file contains the list of wave objects (signals, dividers, groups, virtual buses) to display, and their display properties, plus markers. A wave configuration displays with top-level HDL objects, and can be further populated using commands like add_wave and add_wave_divider.

This command returns the matching wave configuration objects, or returns nothing if no objects matched the search pattern.

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.
Note: The Tcl built-in command 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_wave_configs based on property values on the wave configuration objects. You can find the properties on an object with the report_property or list_property commands. In the case of the "Wave Configuration" object, "NAME", "NEEDS_SAVE", and "FILE_PATH" are some of the properties that can be used to filter results.

The filter search pattern should be quoted to avoid having to escape special characters. String matching is case-sensitive and is always anchored to the start and to the end of the search string. The wildcard “*” character can be used at the beginning or at the end of a search string to widen the search to include a substring of the property value.
Note: The filter returns an object if a specified property exists on the object, and the specified pattern matches the property value on the object. In the case of the "*" wildcard character, this will match a property with a defined value of "".
For string comparison, the specific operators that can be used in filter expressions are "equal" (==), "not-equal" (!=), "match" (=~), and "not-match" (!~). Numeric comparison operators <, >, <=, and >= can also be used. Multiple filter expressions can be joined by AND and OR (&& and ||). The following gets input pins that do NOT contain the “RESET” substring within their name:
get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}
Boolean (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.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

<patterns> - (Optional) Match wave configuration objects in the current simulation against the specified search patterns. The default pattern is the wildcard '*' which gets a list of all open wave configurations in the simulation.

Examples

The following example returns all wave configuration objects, in the current simulation, that have unsaved changes:

get_wave_config -filter {NEEDS_SAVE}