Description
Get IP 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 IP 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 IP settings dictionary
proj = open_project('my_design.pdm')
handler = proj.get_ip_handler('MRMAC')
settings = handler.get_sample_settings()
# settings == {'activity': 'Typical', 'ports': {'port0': {'data_rate': 50, ...}, ...}, ...}
# Get an empty settings template to understand the full structure
template = handler.get_sample_settings(template=True)
# Use sample settings directly to create an IP
handler.create('mrmac1', handler.get_sample_settings())