current_sim - 2023.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2023-05-16
Version
2023.1 English

Set the current simulation object or get the current simulation object

Syntax

current_sim [‑quiet] [‑verbose] [<simulationObject>]

Returns

Returns the current simulation object.

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<simulationObject>] Simulation Object to set the current simulation object to Default: NULL

Categories

Description

Get or set the current Vivado® simulation object.

This command can be used after the Vivado simulator has been launched to return or set the current simulation object.

Arguments

-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.

<simulationObject> - (Optional) The name of the simulation object to set as the current simulation. If a <simulationObject> is not specified, the command returns the current simulation of the current project.

Examples

The following example sets the curent simulation:

current_sim simulation_2