Report properties of object
Syntax
report_property [‑all] [‑class <arg>] [‑return_string] [‑file <arg>]
[‑append] [‑regexp] [‑quiet] [‑verbose] [<object>] [<pattern>]
Returns
Property report
Usage
Name | Description |
---|---|
[-all]
|
Report all properties of object even if not set |
[-class]
|
Object type to query for properties. Not valid with <object> |
[-return_string]
|
Set the result of running report_property in the Tcl interpreter's result variable |
[-file]
|
Filename to output result to. Send output to console if -file is not used |
[-append]
|
Append the results to file, don't overwrite the results file |
[-regexp]
|
Pattern is treated as a regular expression |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<object>]
|
Object to query for properties |
[<pattern>]
|
Pattern to match properties against Default: * |
Categories
Description
Gets the property name, property type, and property value for all of the properties on a specified object, or class of objects.
list_property
also returns a list of all properties on an object, but does not include the property type or value.You can specify objects for report_property
using the get_*
series of commands to get a specific object. You can use the lindex
command to return a specific object from a list of objects:
report_property [lindex [get_cells] 0]
However, if you are looking for the properties on a class of objects, you should use the -class
option instead of an actual object.
This command returns a report of properties on the object, or returns an error if it fails.
Arguments
-all
- (Optional) Return all of the properties for an object, even if the property value is not currently defined.
-class <arg>
- (Optional) Return the properties of the specified class instead of a specific object. The class argument is case sensitive, and most class names are lower case.
-class
cannot be used together with an <object>
.
-return_string
- (Optional) Directs the output to a Tcl string. The Tcl string can be captured by a variable definition and parsed or otherwise processed.
-file <arg>
- (Optional) Write the report into the specified file. The specified file will be overwritten if one already exists, unless -append
is also specified.
-append
- (Optional) Append the output of the command to the specified file rather than overwriting it.
-append
option can only be used with the -file
option.
-regexp
- (Optional) Specifies that the search <patterns> are written as regular expressions. Xilinx® regular expression Tcl commands are always anchored to the start of the search string. You can add ".*" to the beginning or end of a search string to widen the search to include a substring. See http://perldoc.perl.org/perlre.html for help with regular expression syntax.
-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.
<object>
- (Optional) A single object on which to report properties.
<pattern>
- (Optional) Match the available properties on the <object>
or -class
against the specified search pattern. The <pattern>
applies to the property name, and only properties matching the specified pattern will be reported. The default pattern is the wildcard '*' which returns a list of all properties on the specified object.
Examples
The following example returns all properties of the specified object:
report_property -all [get_cells cpuEngine]
The following example returns the properties of the specified class of objects, rather than an actual object:
report_property -class bel
The following example returns properties on the current hw_device
that match the specified pattern, specified as a regular expression:
report_property [current_hw_device] -regexp .*PROG.*
To determine which properties are available for the different design objects supported by the tool, you can use multiple report_property
commands in sequence. The following example returns all properties of the specified current objects:
report_property -all [current_project]
report_property -all [current_fileset]
report_property -all [current_design]
report_property -all [current_run]