Closes the wave config
Syntax
close_wave_config [‑force] [‑quiet] [‑verbose] [<wcfgobj>]Usage
| Name | Description |
|---|---|
[-force]
|
Forces the closing of the wave configuration, even if changes would be lost. Default behavior is to reject the closing with an error if changes would be lost. |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<wcfgobj>]
|
Closes and destroys the specified wave configuration object, or the current wave configuration if none specified Default: NULL |
Categories
Description
Close the current, or specified wave configuration.
In the Vivado® simulator GUI, you can work with a waveform to analyze your design and debug your code. A wave configuration object displays with top-level HDL objects, and can be further populated using commands like add_wave and add_wave_divider. A new wave configuration object can be created in the current simulation with the create_wave_config command.
Any changes made to a wave configuration object can be saved to a Wave Config file with the save_wave_config command. You can open a saved Wave Config file with the open_wave_config command.
Arguments
-force - (Optional) Forces the closing of the Wave Config file, even if changes would be lost. The default behavior is to return an error if unsaved changes would be lost.
-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.current_wave_config command.
get_wave_configs command.Examples
The following example closes all Wave Config files associated with the current simulation:
close_wave_config [get_wave_configs]