common::create_property

説明

オブジェクトのクラスのプロパティを作成します。

構文

create_property [-description <arg>] [-type <arg>] [-enum_values <args>] [-default_value <arg>] [-file_types <args>] [-display_text <arg>] [-quiet] [-verbose] <name> <class>

戻り値

問題なかった場合は、作成されたプロパティ、エラーが発生した場合は ""。

使用法

名前 説明
[-description] プロパティの説明を指定します。
[-type] 作成するプロパティのタイプを指定します。有効な値は string、int、long、double、bool、enum、file で、デフォルトは string です。
[-enum_values] 列挙値を指定します。
[-default_value] タイプ文字列のデフォルト値を指定します。
[-file_types] ファイル タイプの拡張子 (ピリオドなし) を指定します。
[-display_text] ファイル ブラウザーでファイルを選択したときに表示するテキストを指定します。
[-quiet] コマンド エラーを表示しません。
[-verbose] メッセージの非表示設定を解除し、すべてのメッセージを表示します。
<name> 作成するプロパティの名前を指定します。
<class> プロパティを作成するオブジェクト タイプを指定します。有効な値は、design、net、cell、pin、port、pblock、interface、fileset です。

カテゴリ

PropertyAndParameter (プロパティおよびパラメーター)

説明

指定したオブジェクトのクラス (<class>) に対し、指定したタイプ (<type>) のプロパティを指定した名前 (<name>) で作成します。作成したプロパティは、set_property コマンドで指定したクラスのオブジェクトに割り当てることができますが、そのクラスのすべてのオブジェクトに自動的には関連付けられません。

プロパティをそのオブジェクトに割り当てないと、report_property -all コマンドを使用しても、指定したクラスのオブジェクトに対して新しく作成したプロパティはレポートされません。

引数

-description (オプション): 作成するプロパティの説明を指定します。この説明は、HSM ヘルプ システムでこのプロパティをクエリしたときに表示されます。

-type (オプション): 作成するプロパティのタイプを指定します。使用可能なプロパティ タイプは、次のとおりです。

  • string: 新しいプロパティを文字列値で定義します。-type を指定しない場合、これがデフォルト値です。
  • int: 新しいプロパティを -2,147,483,648 ～ 2,147,483,647 の 4 バイト符号付短整数値で定義します。int プロパティ タイプに浮動小数点値を指定すると、HSM ツールでエラー メッセージが返されます。
  • long: 新しいプロパティを -9,223,372,036,854,775,808 ～ 9,223,372,036,854,775,807 の符号付 64 ビット整数で定義します。long プロパティ タイプに浮動小数点値を指定すると、エラー メッセージが返されます。
  • double: 新しいプロパティを浮動小数点値で定義します。
  • bool: 新しいプロパティを true (1 または yes) または false (0 または no) のブール値で定義します。
  • enum: 新しいプロパティを列挙データ型 (-enum_values オプションで指定された有効な列挙値) で定義します。
  • string_list: 新しいプロパティを文字列値の Tcl リストで指定します。
  • int_list: 新しいプロパティを整数値の Tcl リストで指定します。
  • double_list: 新しいプロパティを浮動小数点値の Tcl リストで指定します。

-enum_values <args> (オプション): プロパティに指定可能な列挙値を指定します。複数の値を ({}) で囲み、スペースで区切って指定します。このオプションは、-type enum を使用している場合にのみ使用できます。

-default_value <args> (オプション): プロパティのデフォルト値を指定します。このオプションは、string、int、bool、enum タイプ プロパティに使用できます。

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

<class> (必須): 新しいプロパティを割り当てるオブジェクトのクラスを指定します。指定したクラスのオブジェクトはすべて、新しく定義したプロパティに割り当てられます。有効な値は、design、net、cell、pin、port、pblock、Pblock、interface、fileset です。

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

例

セル オブジェクトに対して PURPOSE というプロパティを定義します。

common::create_property PURPOSE cell
注記: タイプは指定されていないので、値はデフォルトで文字列になります。

整数値を指定する COUNT というピン プロパティを作成します。

common::create_property -type int COUNT pin