common::report_property - 2022.1 日本語

説明

オブジェクトのプロパティをレポートします。

構文

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

戻り値

プロパティレポート。

使用法

名前	説明
[`-all`]	オブジェクトのプロパティを設定していないものも含めてすべてレポートします。
[`-class`]	プロパティを取得するオブジェクトタイプを指定します。<object> を指定する場合は使用できません。
[`-return_string`]	Tcl インタープリターの result 変数に `report_property` の実行結果を設定します。
[`-file`]	結果を保存するファイルの名前を指定します。このオプションを使用しない場合、出力はコンソールに表示されます。
[`-append`]	結果をファイルの最後に追加します。上書きはしません。
[`-regexp`]	検索パターンを正規表現として処理します。
[`-quiet`]	コマンドエラーを表示しません。
[`-verbose`]	メッセージの非表示設定を解除し、すべてのメッセージを表示します。
[<object>]	プロパティを取得するオブジェクトを指定します。
[<pattern>]	プロパティを検索するパターンを指定します。デフォルトは * です。

カテゴリ

Object (オブジェクト)、PropertyAndParameter (プロパティおよびパラメーター)、Report (レポート)

説明

指定したオブジェクトまたはオブジェクトのクラスのすべてのプロパティに対して、その名前、タイプ、および値を取得します。

注記: list_property でもオブジェクトのすべてのプロパティのリストが返されますが、プロパティタイプと値は含まれません。

report_property コマンドのオブジェクトは、get_* コマンドを使用してオブジェクトとして指定できます。lindex コマンドを使用して、オブジェクトのリストから特定のオブジェクトを指定できます。

    report_property [lindex [get_cells] 0]

オブジェクトのクラスのプロパティを見つける場合は、オブジェクトを指定する代わりに -class オプションを使用します。

このコマンドを実行すると、オブジェクトのプロパティのレポートが返されるか、正常に実行されなかった場合はエラーが返されます。

引数

-all (オプション): プロパティ値が定義されていなくても、オブジェクトのすべてのプロパティを返します。

-class <arg> (オプション): 指定したオブジェクトのクラスのプロパティを返します。大文字/小文字が区別されます。ほとんどのクラス名は小文字で記述されます。

注記: -class またはクラスオプションを <object> と共に使用することはできません。

-return_string (オプション): 出力を Tcl 文字列として返します。Tcl 文字列は、変数定義でキャプチャしたり、解析またはその他の処理が可能です。

-file <arg> (オプション): レポートを保存するファイルを指定します。-append オプションが指定されていない場合、指定したファイルが既に存在する場合は上書きされます。

注記: パスをファイル名の一部として指定しない場合は、現在の作業ディレクトリまたはツールを起動したディレクトリにファイルが作成されます。

-append (オプション): コマンドの出力を指定したファイルに上書きするのではなく追加します。

注記: -append オプションは、-file オプションを使用している場合にのみ使用可能です。

-regexp (オプション): 検索パターンが正規表現で記述されていることを指定します。

-quiet (オプション): コマンドをメッセージを表示せずに実行します。実行中にエラーが発生しても、TCL_OK が返されます。

注記: コマンドを実行したときにコマンドラインで発生したエラーは返されます。コマンド内で発生したエラーのみが非表示になります。

-verbose (オプション): メッセージの非表示設定を一時的に解除し、コマンドからのすべてのメッセージを返します。

注記: メッセージの非表示設定は、set_msg_config コマンドで定義できます。

注記: 複数のオブジェクトを指定すると、エラーメッセージが表示されます。

<pattern> (オプション): 指定した <object> のプロパティまたは -class オプションで指定したオブジェクトクラスのプロパティを検索するパターンを指定します。プロパティ名が指定の検索パターンに一致するプロパティのみが返されます。デフォルトの検索パターンはワイルドカード (*) で、指定したオブジェクトのプロパティすべてのリストが取得されます。

注記: 大文字/小文字が区別されます。ほとんどのプロパティ名は大文字で記述されます。

例

次の例では、指定したオブジェクトのプロパティすべてが返されます。

common::report_property -all [get_cells microblaze_0]

ツールでサポートされる異なるデザインオブジェクトに使用可能なプロパティを取得するには、複数の report_property コマンドを連続して使用します。次の例では、指定したオブジェクトのプロパティすべてが返されます。

common::report_property -all [current_hw_design]

common::report_property -all [current_sw_design]