common::set_property

説明

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

構文

set_property [-dict <args>] [-quiet] [-verbose] <name> <value> <objects>... 

戻り値

なし。

使用法

名前 説明
[-dict] 設定するプロパティの名前と値のペアを指定します。
[-quiet] コマンド エラーを表示しません。
[-verbose] メッセージの非表示設定を解除し、すべてのメッセージを表示します。
<name> 設定するプロパティの名前を指定します。-dict オプションと共に使用することはできません。
<value> 設定するプロパティの値を指定します。-dict オプションと共に使用することはできません。
<objects> プロパティを設定するオブジェクトの名前を指定します。

カテゴリ

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

説明

指定のオブジェクトにプロパティと値を設定します。

このコマンドは、デザインのオブジェクトに対してプロパティを定義するために使用できます。各オブジェクトにはあらかじめ定義されたプロパティがあり、指定可能な値または値の範囲があります。これらのプロパティの値を指定するには、set_property コマンドを使用します。オブジェクトのプロパティに設定されている値を確認するには、report_propertylist_property、または list_property_values コマンドを使用します。

オブジェクトには、固有の <name> と <value> のペアを指定することにより、カスタム プロパティも設定できます。オブジェクトにカスタム プロパティがある場合、report_property または list_property コマンドのレポートに含まれます。

このコマンドが正常に実行された場合は何も返されず、正常に実行されない場合はエラーが返されます。

注記: get_property コマンドを使用すると、オブジェクトに設定されたプロパティを確認できます。

引数

-dict (オプション): 1 つの set_property コマンドで、1 つのオブジェクトに対して複数のプロパティ (<name> と <value> のペア) を指定する際に使用します。複数の <name> と <value> のペアは、波かっこ ( { } ) またはダブルクォーテーション ("") で囲んで指定します。

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

<name> (必須): オブジェクトに設定するプロパティの名前を指定します。<name> では大文字/小文字が区別されるので、適切に指定してください。

<value> (必須): 指定のオブジェクトの <name> プロパティに設定する値を指定します。プロパティ タイプに対して値が有効であるかどうかがチェックされます。値が指定のプロパティに有効でない場合は、エラーが返されます。

注記: プロパティの値にダッシュ (-) などの特殊文字が含まれる場合があり、これによってダッシュ以降の値がコマンドの別のオプションと解釈されてしまう場合があります。この場合、ここに説明するように、位置引数 (name、value、objects) ではなく明示的なオプション (-name、-value、-objects) を使用してください。これを下の例に示します。

<objects> (必須): プロパティを割り当てる 1 つまたは複数のオブジェクトを指定します。

次の例は、セル オブジェクトに TRUTH というユーザー定義のブール型プロパティを作成し、セルに設定します。
common::create_property -type bool truth cell
common::set_property truth false [lindex [get_cells] 1]
次の例は、指定したソフトウェア プロセッサのコンパイラおよびアーカイブ プロパティの値を指定します。
common::set_property CONFIG.archiver armar [get_sw_processor]
common::set_property CONFIG.compiler armcc [get_sw_processor]