Intel® Quartus® Prime Pro Edition User Guide: Platform Designer

ID 683609
Date 9/26/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

8.13.9. Parameter Properties

Type Name Description
Boolean AFFECTS_ELABORATION Set AFFECTS_ELABORATION to false for parameters that do not affect the external interface of the module. An example of a parameter that does not affect the external interface is isNonVolatileStorage. An example of a parameter that does affect the external interface is width. When the value of a parameter changes and AFFECTS_ELABORATION is false, the elaboration phase does not repeat and improves performance. When AFFECTS_ELABORATION is set to true, the default value, Platform Designer reanalyzes the HDL file to determine the port widths and configuration each time a parameter changes.
Boolean AFFECTS_GENERATION The default value of AFFECTS_GENERATION is false if you provide a top-level HDL module. The default value is true if you provide a fileset callback. Set AFFECTS_GENERATION to false if the value of a parameter does not change the results of fileset generation.
Boolean AFFECTS_VALIDATION The AFFECTS_VALIDATION property determines whether a parameter's value sets derived parameters, and whether the value affects validation messages. Setting this property to false may improve response time in the parameter editor when the value changes.
String[] ALLOWED_RANGES Indicates the range or ranges of the parameter. For integers, each range is a single value, or a range of values defined by a start and end value, and delimited by a colon, for example, 11:15. This property also specifies the legal values and description strings for integers, for example, {0:None 1:Monophonic 2:Stereo 4:Quadrophonic}, where 0, 1, 2, and 4 are the legal values. You can assign description strings in the parameter editor for string variables. For example,
ALLOWED_RANGES {"dev1:Cyclone IV GX""dev2:
               Stratix® V
				GT"}
String DEFAULT_VALUE The default value.
Boolean DERIVED When True, indicates that the parameter value is set by the component and cannot be set by the user. Derived parameters are not saved as part of an instance's parameter values. The default value is False.
String DESCRIPTION A short user-visible description of the parameter, suitable for a tooltip description in the parameter editor.
String[] DISPLAY_HINT Provides a hint about how to display a property.
  • boolean--For integer parameters whose value are 0 or 1. The parameter displays as an option that you can turn on or off.
  • radio—displays a parameter with a list of values as radio buttons.
  • hexadecimal—for integer parameters, displays and interprets the value as a hexadecimal number, for example: 0x00000010 instead of 16.
  • fixed_size—for string_list and integer_list parameters, the fixed_size DISPLAY_HINT eliminates the Add and Remove buttons from tables.
String DISPLAY_NAME The GUI label that appears to the left of this parameter.
String DISPLAY_UNITS The GUI label that appears to the right of the parameter.
Boolean ENABLED When False, the parameter is disabled. The parameter displays in the parameter editor but is grayed out, indicating that you cannot edit this parameter.
String GROUP Controls the layout of parameters in the GUI.
Boolean HDL_PARAMETER When True, Platform Designer passes the parameter to the HDL component description. The default value is False.
String LONG_DESCRIPTION A user-visible description of the parameter. Similar to DESCRIPTION, but allows a more detailed explanation.
String NEW_INSTANCE_VALUE Changes the default value of a parameter without affecting older components that do not explicitly set a parameter value, and use the DEFAULT_VALUE property. Oder instances continue to use DEFAULT_VALUE for the parameter and new instances use the value assigned by NEW_INSTANCE_VALUE.
String[] SYSTEM_INFO Allows you to assign information about the instantiating system to a parameter that you define. SYSTEM_INFO requires an argument specifying the type of information. For example:
SYSTEM_INFO <info-type>
String SYSTEM_INFO_ARG Defines an argument to pass to SYSTEM_INFO. For example, the name of a reset interface.
(various) SYSTEM_INFO_TYPE Specifies the types of system information that you can query. Refer to System Info Type Properties.
(various) TYPE Specifies the type of the parameter. Refer to Parameter Type Properties.
(various) UNITS Sets the units of the parameter. Refer to Units Properties.
Boolean VISIBLE Indicates whether or not to display the parameter in the parameter editor.
String WIDTH Indicates the width of the logic vector for the STD_LOGIC_VECTOR parameter.