説明
指定したレコード名をキーとし、指定した書き込み可能フィールド名とデフォルト値のマッピングを保持するディクショナリを値とするディクショナリを取得します。ただし、レコード間でデフォルトが異なり、all_records が True の場合に限ります。それ以外の場合は、リソースに対する指定した書き込み可能フィールド名とデフォルト値のマッピングのディクショナリを取得します。指定されていても、読み取り専用フィールドは除外されます。
構文
get_default_values([<field_names>], [<record_names>], all_records=False)
戻り値
all_records が True の場合は {record: {field: default_value, ...}, ...} 形式、それ以外の場合は {field: default_value, ...} 形式のディクショナリ。
パラメーター
| 名前 | 説明 |
|---|---|
| [<field_names>] | フィールド名のリスト。 デフォルト: すべてのフィールド |
| [<record_names>] | レコード名のリスト。指定されている場合、all_records フラグは無視され、リスト内のレコードのみが考慮されます。 デフォルト: all_records の値に依存します。 |
| [all_records] | True の場合、同一フィールドでもレコードごとにデフォルトが異なる可能性を考慮し、各レコードのデフォルトを返します。それ以外の場合は、リソース全体で共通のデフォルトのみを返します。 デフォルト: False |
例
# Get default values for the resource (shared across all records)
proj = open_project('my_design.pdm')
io_config = proj.get_block('io').get_resource('io_config')
defaults = io_config.get_default_values()
# defaults == {'io_type': 'XP', 'io_standard': 'LVCMOS 1.5V 12mA', 'input_pins': 0, ...}
# Get default values for specific fields only
defaults = io_config.get_default_values(['io_type', 'toggle_rate'])
# Get default values per record (may differ from resource-level defaults)
all_defaults = io_config.get_default_values(all_records=True)
# all_defaults == {'io_inst1': {'io_type': 'XP', 'io_standard': 'LVCMOS 1.5V 12mA', ...}, ...}