Add/Edit Configuration Variable Dialog

The Add / Edit Configuration Variable dialog is used to create and edit configuration variables.

Add Configuration Variable Dialog

Variable Name

Sets the name of the constant that will be made available to XJEase. Since it is an XJEase symbol, the name must be a valid XJEase symbol name. This means that:

  • It must begin with an ASCII letter or an underscore (a..z, A..Z or _).
  • Be followed by any number of ASCII letters, numbers or underscores (a..z, A..Z, 0-9 or _) .
  • It cannot conflict with any XJEase keyword or any keyword from an XJTAG project or device file.

The Variable Name cannot be left empty.

Display Name

Sets the name of the variable as it will be displayed to the user when the variable is being configured for a device. This is a more descriptive name for the value, with no constraints other than it cannot be empty.

Type

This dropdown specifies the type of the variable. Each of these types maps to either an XJEase INT or STRING variable.

NameXJEase TypeDescription
Integer INT An unsigned integer displayed in a simple textbox, The user can supply the value either in decimal (e.g. "42"), hexadecimal (e.g. "0x2a") or binary (e.g. "0b101010").
Boolean INT A value that is either true or false. This will be displayed as a checkbox and the XJEase variable will be an INT that is either 0 if the checkbox is unchecked or 1 if it is checked.
String STRING A string value displayed in a simple textbox.
Filename STRING A string value displayed in a simple textbox with a Browse button next to it, so that a file can be selected from the file system.
Integer list INT Provides the user with a list of values from which to select one. Each entry in the list is an integer value with an associated description. The descriptions are presented to the user to select one, and the associated integer value is assigned to the XJEase variable.
String list STRING Provides the user with a list of values from which to select one. Each entry in the list is a string value with an associated description. The descriptions are presented to the user to select one, and the associated string value is assigned to the XJEase variable.

Condition

This dropdown optionally allows another variable to be selected as a condition variable, whose value will control whether this variable is enabled or not.

Description

The description should provide any extra information that might be useful to the user when they are configuring a test device. It is displayed in a tooltip when editing the variables.

Default Value

Allows a default value to be defined.

Editing List Type Values

If a list type is chosen a grid is displayed to edit the list's entries and associated values.

Edit Configuration Variables Enum
  • To add a new entry to the list, enter a description and associated value into an empty row.
  • Click Remove to remove the currently selected item(s) in the list.
  • Entries can be moved up an down the list using the Up and Down buttons.

Note that the description and value for each list entry must be unique and not be empty. Integer list values must be valid integers.

Validation

If any of the data is invalid, a red exclamation icon will appear next to the item to indicate that it needs to be corrected, and the OK button will be disabled.

If there is no invalid data, click OK to save the current settings for the variable.

Click Cancel to discard any changes and close the dialog.

See Also