6.6.2.1 Creating a New Tree Defined Field
Click the Add a new Tree Defined Field button to add a new TDF in the editor, and an editing dialog for creating new TDFs appears, see Figure 52.
The following options are available for creating a new TDF:
- Name
It is mandatory to have a name on a TDF, so this text field cannot be empty. The name must be unique. The name cannot have more than 200 characters.
- Data Type
The data type to use for the TDF is selected in the drop-down dialog, see Figure 52. For available data types, see Table 47. If a data type is not chosen for the field, the TDF is created as a Text field.
| Data type | GUI name | Allowed characters | Range | Default value |
|---|---|---|---|---|
| Amount | Amount | Numerical and a dot | 0 - 999999999999999 | 0 |
| Boolean | Boolean | True or false | False | |
| Date | Date | 0 - 9 and hyphens in the format YYYY-MM-DD | Current date | |
| Floating Point | Floating-point number | Numerical and a dot | 0.0 | |
| Long | Number | Numerical | Minimum value: -9,223,372,036,854,775,808 Maximum value 9,223,372,036,854,775,807 | 0 |
| String | Text | All | ||
| Time | Time | 0 - 9, hyphens, and colons, in the format YYYY-MM-DD hh:mm:ss | Current time and date |
- Default value
Default value is an optional parameter. The default value is used if the user wishes to have a default or start value for the TDF other than the ordinary for the given data type, see Table 47. If the entered value is out of the minimum or maximum bounds for the selected data type, a warning is given in the status bar, it is not possible to enter the faulty value.
If a range is selected for a TDF of the type Number, the Default field will not have this restriction. This to enable the possibility to have a start value outside the range which represents that no value has been set.
The TDF is created with the submitted default value. The submitted value is not considered as default value in, for example, the CompareField condition or Set Field modifier, when the TDF is used there.
- Input restrictions
This is an optional choice. Input restrictions are used if the user wishes to restrict the value that can be set for the TDF in the CompareField condition, modifier Set Field, and in the Simulation Panel. It is possible to set a range and also define exactly what values can be chosen.
NO DATA – Default value, input is not restricted in any other way that what values the chosen data type can take, see ranges in Table 47..
ENUMERATION – With enumeration of the exact values for this TDF. A field with a button Edit appears right under Simulation Data when Enumeration is selected. By clicking Edit a dialog frame appears with edit possibilities for what values should be possible for this TDF, see Section 5.3.6.2.2.
In the editor it is possible to add more rows, delete rows and reset all.
RANGE – With the range option it is possible to choose a range within what bounds values is possible to be set for the TDF. A Min and Max field appears right under the Simulation Data in the TDFs Edit dialog when Range is selected. By filling in the Min and Max field the exact range of allowed values for this field are specified. It is also possible to use the range of the data type long, by selecting the Min and Max box. The Min and Max fields are automatically filled with the minimum and maximum value of data type long. This is the same as not selecting a range for the field at all. The range option is available for the data type Number.
If the number submitted Max or Min value is out of range, an error message is shown in the lower left part of the RMA GUI, see Figure 53.
