Description
Get clock settings template dictionary with valid values, alternatively, if the flag is enabled, retrieve the complete structure of the settings hierarchy with all values set to zero or an empty string.
Syntax
get_sample_settings(template=False)
Returns
Dictionary of clock settings.
Parameters
| Name | Description |
|---|---|
| [template] | Enables returning the full settings dictionary with zero or empty values. Default: False |
Examples
# Get a ready-to-use sample clock settings dictionary
proj = open_project('my_design.pdm')
clock_handler = proj.get_clock_handler()
settings = clock_handler.get_sample_settings()
# settings == {'freq': 100.0, 'io_type': 'HD', 'io_standard': 'LVCMOS 1.8V',
# 'is_gated': False, 'min_scaled_freq': 0.0}
# Get an empty settings template to see the full structure
template = clock_handler.get_sample_settings(template=True)