Report properties of object.
report_property [-all] [-class <arg>] [-return_string] [-file <arg>] [-append] [-regexp] [-quiet] [-verbose] [<object>] [<pattern>]
||Report all properties of object even if not set|
||Object type to query for properties. Not valid with <object>|
||Set the result of running
||Filename to output result to. Send output to console if -file is not used|
||Append the results to file; do not overwrite the results file|
||Pattern is treated as a regular expression|
||Ignore command errors|
||Suspend message limits during command execution|
|[<object>]||Object to query for properties|
|[<pattern>]||Pattern to match properties against Default: *|
Object, PropertyAndParameter, Report
Gets the property name, property type, and property value for all of the properties on a specified object, or class of objects.
list_propertyalso returns a list of all properties on an object, but does not include the property type or value.
report_propertyusing 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.
-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.
-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.
-regexp- (optional) Specifies that
the search <pattern> is written as a regular expression.
-quiet– (optional) Execute the command quietly, returning no messages from the command. The command also returns
TCL_OKregardless of any errors encountered during execution.
-verbose– (optional) Temporarily override any message limits and return all messages from this command.
<object> - (optional) A single object on which to report properties.
The following example returns all properties of the specified object:
common::report_property -all [get_cells microblaze_0]
To determine which properties are available for the different design
objects supported by the tool, you can use multiple
commands in sequence. The following example returns all properties of the specified
common::report_property -all [current_hw_design]
common::report_property -all [current_sw_design]