locate (::quartus::sta)

The following table displays information for the locate Tcl command:

Tcl Package and Version

Belongs to ::quartus::sta 1.0

Syntax locate [-h | -help] [-long_help] [-chip] [-classic_tmv] [-color <black|blue|brown|green|grey|light_grey|orange|purple|red|white> ] [-label <label> ] [-no_duplicates] [-rpe] [-rtm] [-tmv] <items>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-chip Locate the object in the Chip Planner
-classic_tmv Locate the object in the Classic Technology Map Viewer
-color <black|blue|brown|green|grey|light_grey|orange|purple|red|white> Specify the color to be used to identify the objects you are locating
-label <label> Specify a label used to identify the objects you are locating
-no_duplicates Do not locate duplicate objects
-rpe Locate in the Resource Property Editor
-rtm Locate in the Hyper-Retiming Viewer
-tmv Locate the object in the Technology Map Viewer
<items> Items to locate. Any collection or object (such as paths, points, nodes, nets, keepers, registers, etc) may be located by passing a reference to the corresponding collection or object.
Description
Locate an object from the Timing Analyzer in another Quartus Prime tool.

With this command, one or more objects, or collections of objects,
can be located in a supported Quartus tool from the Timing Analyzer.

The destination must be specified with one of the following 
options:

	Option         Destination Tool
	======         ==============================
    -chip          Chip Planner
    -rpe           Resource Property Editor
    -rtl           RTL Viewer
    -classic_rtl   Classic RTL Viewer
    -tmv           Technology Map Viewer
    -classic_tmv   Classic Technology Map Viewer
    -rtm           Hyper-Retiming Viewer

The -label option can be used to specify a label for the located
objects.  The -color command can be used to specify a color to 
be used to identify the located objects in the destination tool.
Example Usage
proc prepare_design { } {
	set sleep_for 2000

	create_timing_netlist -risefall 

	post_message -type info "Give the GUI some time to catch up to the new netlist. Sleep for $sleep_for ms"
	after $sleep_for

	read_sdc 
	update_timing_netlist
}

prepare_design

# Locate all of the nodes in the longest ten paths
# into the Resource Property Editor
locate [get_path -npaths 10] -rpe

# Locate ten paths into the chip planner, labelling
# each one individually.
set path_col [get_timing_paths -npaths 10]
set path_id 0

foreach_in_collection path $path_col {
	incr path_id

	locate -label "Path #$path_id" $path -chip
}

# locate all keepers that begin with the letter t
# to the Tech Map Viewer
locate [get_keepers t*] -tmv

# locate all nodes that begin with the letter a
#
# The Timing Analyzer GUI will prompt the user for the
# tool to which the nodes should be located.
#
# Pause first to allow the previous locations to
# appear, as the dialog that pops up, to ask 
# the user for a location, will block the rest 
# of the GUI until cleared.

after 5000

post_message -type info "Interactive locate"
locate a*		
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Illegal color: <string>. Specify a color that is currently supported by the locate command.
TCL_ERROR 1 ERROR: An object or collection matching <string> could not be found, or was of a type not supported by the locate command.
TCL_ERROR 1 ERROR: Timing netlist does not exist. Use create_timing_netlist to create a timing netlist.