common::get_property - 2022.1 日本語

Vitis 統合ソフトウェア プラットフォームの資料: エンベデッド ソフトウェア開発 (UG1400)

Document ID
UG1400
Release Date
2022-04-26
Version
2022.1 日本語

説明

オブジェクトのプロパティを取得します。

構文

get_property [-min] [-max] [-quiet] [-verbose] <name> <object> 

戻り値

プロパティ値。

使用法

名前 説明
[-min] 最小値のみを返します。
[-max] 最大値のみを返します。
[-quiet] コマンド エラーを表示しません。
[-verbose] メッセージの非表示設定を解除し、すべてのメッセージを表示します。
<name> 値を取得するプロパティの名前を指定します。
<object> プロパティを取得するオブジェクトを指定します。

カテゴリ

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

説明

指定したオブジェクトの指定したプロパティの現在の値を取得します。複数のオブジェクトを指定した場合、値のリストが返されます。

オブジェクトに指定のプロパティが設定されていない場合、または値が設定されていない場合は、get_property コマンドは何も返しません (NULL 文字列)。複数のオブジェクトを指定した場合、NULL 文字列が返される値のリストに追加されます。

このコマンドを実行すると、値または値のリストが返されるか、正常に実行されなかった場合はエラーが返されます。

引数

-min (オプション): 複数のオブジェクトを指定した場合に、指定したプロパティの値を調べ、オブジェクトのリストから最小値のみを返します。最小値/最大値は、値が数値のプロパティでは数値に基づき、その他のプロパティでは文字列の並べ替え順に基づいて決定されます。

-max (オプション): 複数のオブジェクトを指定した場合に、指定したプロパティの値を調べ、オブジェクトのリストから最大値のみを返します。最小値/最大値は、値が数値のプロパティでは数値に基づき、その他のプロパティでは文字列の並べ替え順に基づいて決定されます。

-quiet (オプション): コマンドをメッセージを表示せずに実行します。実行中にエラーが発生しても、TCL_OK が返されます。
注記: コマンドを実行したときにコマンド ラインで発生したエラーは返されます。コマンド内で発生したエラーのみが非表示になります。
-verbose (オプション): メッセージの非表示設定を一時的に解除し、コマンドからのすべてのメッセージを返します。
注記: メッセージの非表示設定は、set_msg_config コマンドで定義できます。

<name> (必須): 値を取得するプロパティの名前を指定します。大文字/小文字は区別されません。

<object> (必須): 指定したプロパティの値を取得する 1 つまたは複数のオブジェクトを指定します。

次の例は、指定したセルの NAME プロパティを取得します。

common::get_property NAME [lindex [get_cells] 0]

現在のハードウェア デザインから BOARD プロパティを取得します。

common::get_property BOARD [current_hw_design]