Remove enumerated name-value pairs from a hw_probe enumeration.
Syntax
remove_hw_probe_enum [‑no_gui_update] [‑list <args>] [‑remove_all] [‑quiet]
[‑verbose] <hw_probe>Usage
| Name | Description |
|---|---|
[-no_gui_update]
|
Defer GUI update. |
[-list]
|
List of enumerated names to remove. |
[-remove_all]
|
Remove the whole enumeration for a hardware probe. Default: 0 |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
<hw_probe>
|
ILA hardware probe object. |
Categories
Description
Remove the enumerated name/value pairs defined on a specified hw_probe object.
The enumerated names (ENUM property) are added to a hw_probe object using the add_hw_probe_enum command. This command removes those defined properties.
This command returns nothing if successful, or returns an error if it fails.
Arguments
-no_gui_update - (Optional) Do not update the GUI in the Vivado® logic analyzer to remove the enumerated values of the probe.
-list <args> - (Optional) Remove the specified list of enumerated names from the specified <hw_probe> object.
-remove_all - (Optional) Remove all of the ENUM properties defined on the specified <hw_probe> object. This option cannot be used with the -list option.
-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.<hw_probe> - (Required) Specify the hw_probe objects to remove the ENUM property from.
Examples
remove_hw_probe_enum -list {WHITE YELLOW GREY} \
[get_hw_probes op1 -of_objects [current_hw_ila]]