common::report_property - 2023.2 简体中文

Vitis 统一软件平台文档 嵌入式软件开发 (UG1400)

Document ID
UG1400
Release Date
2023-12-13
Version
2023.2 简体中文

描述

报告对象的属性。

语法

report_property [-all] [-class <arg>] [-return_string] [-file <arg>] [-append] [-regexp] [-quiet] [-verbose] [<object>] [<pattern>] 

返回

属性报告。

用法

名称 描述
[-all] 报告对象的所有属性(即使未设置)
[-class] 要查询其属性的对象类型。对于 <object> 无效
[-return_string] 用于设置在 Tcl 解释器的结果变量中运行 report_property 的结果
[-file] 结果输出到的文件名。如果不使用 -file,则将输出发送到控制台
[-append] 将结果追加到文件;不覆盖结果文件
[-regexp] 模式作为正则表达式来处理
[-quiet] 忽略命令错误
[-verbose] 命令执行期间暂挂消息限制
[<object>] 要查询其属性的对象
[<pattern>] 基于默认值匹配属性的模式:*

类别

Object、PropertyAndParameter 和 Report

描述

获取指定对象或者对象类的所有属性的属性名称、属性类型和属性值。

注释: list_property 还可返回对象的所有属性的列表,但其中不包含属性类型或属性值。
您可以使用 get_* 系列命令为 report_property 指定对象,以获取特定对象。您可以使用 lindex 命令返回来自对象列表的特定对象:
    report_property [lindex [get_cells] 0]

但如果您要查找某一对象类的属性,则应使用 -class 选项代替实际对象。

此命令会返回对象的属性报告,或者如果失败则返回错误。

实参

-all> -(可选)返回某一对象的所有属性,即使当前未定义属性值也是如此。

-class <arg> -(可选)返回指定类的属性,而不是返回特定对象。类实参区分大小写,大部分类名均为小写。
注释: -class 不能搭配 <object> 一起使用

-return_string -(可选)将输出定向至 Tcl 字符串。Tcl 字符串可通过变量定义来捕获并进行解析或处理。

-file<arg> -(可选)将报告写入指定文件。指定的文件如果已存在,则将覆盖,除非同时指定 -append。

注释: 如果在文件名中未指定路径,那么此文件将写入当前工作目录,或者启动该工具的目录。

-append -(可选)将命令输出追加到指定文件中,而不是覆盖文件。

注释: -append 选项只能搭配 -file 选项一起使用。

-regexp -(可选)指定以正则表达式形式写入搜索 <pattern>。

-quiet -(可选)以静默方式执行命令,不返回来自该命令的任何消息。此命令还会返回 TCL_OK,忽略执行期间遇到的所有错误。
注释: 启动该命令时,会返回命令行上遇到的任何错误。仅捕获该命令内部发生的错误。
-verbose -(可选)暂时改写任何消息限制,并返回来自该命令的所有消息。
注释: 可使用 set_msg_config 命令定义消息限制。

<object> -(可选)单一对象,报告该对象的属性。

注释: 如果指定多个对象,则会报错。
<pattern> -(可选)基于指定搜索模式匹配 <object> 或 -class 上的可用属性。<pattern> 适用于属性名称,并且仅报告与指定模式相匹配的属性。默认模式为通配符 `*`,返回指定对象的所有属性的列表。
注释: 搜索模式区分大小写,大部分属性均为大写。

示例

以下示例返回指定对象的所有属性:

common::report_property -all [get_cells microblaze_0]

要判定哪些属性可用于该工具支持的不同设计对象,可以按顺序使用多条 report_property 命令。以下示例返回指定的当前对象的所有属性:

common::report_property -all [current_hw_design]
common::report_property -all [current_sw_design]