report_design_metrics (::quartus::sta)

Tcl Package and Version

Syntax

report_design_metrics [-h | -help] [-long_help] [-append] [-fall_from <names> ] [-fall_from_clock <names> ] [-fall_through <names> ] [-fall_to <names> ] [-fall_to_clock <names> ] [-file <name> ] [-from <names> ] [-from_clock <names> ] [-hold] [-less_than_slack <slack limit> ] [-logic_depth] [-neighbor_paths] [-npaths <number> ] [-nworst <number> ] [-pairs_only] [-panel_name <name> ] [-recovery] [-removal] [-rise_from <names> ] [-rise_from_clock <names> ] [-rise_through <names> ] [-rise_to <names> ] [-rise_to_clock <names> ] [-setup] [-stdout] [-through <names> ] [-to <names> ] [-to_clock <names> ]

Arguments

-h | -help

Short help

-long_help

Long help with examples and possible return values

-append

If output is sent to a file, this option appends the result to that file. Otherwise, the file will be overwritten. This option is not supported for HTML files.

-fall_from <names>

Valid sources (string patterns are matched using Tcl string matching)

-fall_from_clock <names>

Valid source clocks (string patterns are matched using Tcl string matching)

-fall_through <names>

Valid through nodes (string patterns are matched using Tcl string matching)

-fall_to <names>

Valid destinations (string patterns are matched using Tcl string matching)

-fall_to_clock <names>

Valid destination clocks (string patterns are matched using Tcl string matching)

-file <name>

Sends the results to an ASCII or HTML file. Depending on the extension

-from <names>

Valid sources (string patterns are matched using Tcl string matching)

-from_clock <names>

Valid source clocks (string patterns are matched using Tcl string matching)

-hold

Option to report clock hold paths

-less_than_slack <slack limit>

Limit the paths reported to those with slack values less than the specified limit.

-logic_depth

Run the logic depth analysis

-neighbor_paths

Run the neighbor paths analysis

-npaths <number>

Specifies the number of paths to report (default=1, or the same value as nworst, if nworst is specified. Value of 0 causes all paths to be reported but be wary that this may be slow)

-nworst <number>

Specifies the maximum number of paths to report for each endpoint. If unspecified, there is no limit. If nworst is specified, but npaths is not, npaths defaults to the same value as nworst

-pairs_only

When set, paths with the same start and end points are considered equivalent. Only the worst case path for each unique combination is displayed.

-panel_name <name>

Sends the results to the panel and specifies the name of the new panel

-recovery

Option to report recovery paths

-removal

Option to report removal paths

-rise_from <names>

Valid sources (string patterns are matched using Tcl string matching)

-rise_from_clock <names>

Valid source clocks (string patterns are matched using Tcl string matching)

-rise_through <names>

Valid through nodes (string patterns are matched using Tcl string matching)

-rise_to <names>

Valid destinations (string patterns are matched using Tcl string matching)

-rise_to_clock <names>

Valid destination clocks (string patterns are matched using Tcl string matching)

-setup

Option to report clock setup paths

-stdout

Send output to stdout, via messages. You only need to use this option if you have selected another output format, such as a file, and would also like to receive messages.

-through <names>

Valid through nodes (string patterns are matched using Tcl string matching)

-to <names>

Valid destinations (string patterns are matched using Tcl string matching)

-to_clock <names>

Valid destination clocks (string patterns are matched using Tcl string matching)

Description

This command currently contains no help description.

Example Usage

This command currently contains no example usage.

Return Value

Code Name

Code

String Return

TCL_OK

0

INFO: Operation successful

Tcl Package and Version	Belongs to ::quartus::sta 1.0
Syntax	`report_design_metrics [-h \| -help] [-long_help]` `[-append]` `[-fall_from` <names> `]` `[-fall_from_clock` <names> `]` `[-fall_through` <names> `]` `[-fall_to` <names> `]` `[-fall_to_clock` <names> `]` `[-file` <name> `]` `[-from` <names> `]` `[-from_clock` <names> `]` `[-hold]` `[-less_than_slack` <slack limit> `]` `[-logic_depth]` `[-neighbor_paths]` `[-npaths` <number> `]` `[-nworst` <number> `]` `[-pairs_only]` `[-panel_name` <name> `]` `[-recovery]` `[-removal]` `[-rise_from` <names> `]` `[-rise_from_clock` <names> `]` `[-rise_through` <names> `]` `[-rise_to` <names> `]` `[-rise_to_clock` <names> `]` `[-setup]` `[-stdout]` `[-through` <names> `]` `[-to` <names> `]` `[-to_clock` <names> `]`
Arguments	`-h \| -help`		Short help
	`-long_help`		Long help with examples and possible return values
	`-append`		If output is sent to a file, this option appends the result to that file. Otherwise, the file will be overwritten. This option is not supported for HTML files.
	`-fall_from` <names>		Valid sources (string patterns are matched using Tcl string matching)
	`-fall_from_clock` <names>		Valid source clocks (string patterns are matched using Tcl string matching)
	`-fall_through` <names>		Valid through nodes (string patterns are matched using Tcl string matching)
	`-fall_to` <names>		Valid destinations (string patterns are matched using Tcl string matching)
	`-fall_to_clock` <names>		Valid destination clocks (string patterns are matched using Tcl string matching)
	`-file` <name>		Sends the results to an ASCII or HTML file. Depending on the extension
	`-from` <names>		Valid sources (string patterns are matched using Tcl string matching)
	`-from_clock` <names>		Valid source clocks (string patterns are matched using Tcl string matching)
	`-hold`		Option to report clock hold paths
	`-less_than_slack` <slack limit>		Limit the paths reported to those with slack values less than the specified limit.
	`-logic_depth`		Run the logic depth analysis
	`-neighbor_paths`		Run the neighbor paths analysis
	`-npaths` <number>		Specifies the number of paths to report (default=1, or the same value as nworst, if nworst is specified. Value of 0 causes all paths to be reported but be wary that this may be slow)
	`-nworst` <number>		Specifies the maximum number of paths to report for each endpoint. If unspecified, there is no limit. If nworst is specified, but npaths is not, npaths defaults to the same value as nworst
	`-pairs_only`		When set, paths with the same start and end points are considered equivalent. Only the worst case path for each unique combination is displayed.
	`-panel_name` <name>		Sends the results to the panel and specifies the name of the new panel
	`-recovery`		Option to report recovery paths
	`-removal`		Option to report removal paths
	`-rise_from` <names>		Valid sources (string patterns are matched using Tcl string matching)
	`-rise_from_clock` <names>		Valid source clocks (string patterns are matched using Tcl string matching)
	`-rise_through` <names>		Valid through nodes (string patterns are matched using Tcl string matching)
	`-rise_to` <names>		Valid destinations (string patterns are matched using Tcl string matching)
	`-rise_to_clock` <names>		Valid destination clocks (string patterns are matched using Tcl string matching)
	`-setup`		Option to report clock setup paths
	`-stdout`		Send output to stdout, via messages. You only need to use this option if you have selected another output format, such as a file, and would also like to receive messages.
	`-through` <names>		Valid through nodes (string patterns are matched using Tcl string matching)
	`-to` <names>		Valid destinations (string patterns are matched using Tcl string matching)
	`-to_clock` <names>		Valid destination clocks (string patterns are matched using Tcl string matching)
Description	This command currently contains no help description.
Example Usage	This command currently contains no example usage.
Return Value	Code Name	Code	String Return
TCL_OK	0	INFO: Operation successful