interface data_table set cell
Allows you to alter the cells in a data table field.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating each item by its row and column index. The data table can be created on a dialog box and the data is displayed using this command. The cell properties like width, contents and associated command can be edited by using the set command.
Format:
interface data_table set cell |
|---|
data_table_name = | An Existing GI_data_table |
use_cell_selected = | True_only |
use_row_selected = | True_only |
row_range = | Integer |
column_range = | Integer |
order = | Matrix_input_order |
repeat_strings = | Boolean |
strings = | String |
reals = | Real |
action = | Col_action |
execute = | Boolean |
Example:
interface data_table set cell & |
|---|
data_table_name = | .gui.param.dtable & |
row_range = | 18,19 & |
column_range= | 1,2 & |
order = | by_row & |
repeat_strings = | yes & |
strings = | this_is_to_append & |
action = | prefix & |
execute = | yes |
Description:
Parameter | Value Type | Description |
|---|
data_table _name | An Existing GI_data_table | Specifies the name of an existing data table |
use_cell_selected | True_only | Specifies the cell of cells to be altered |
use_row_selected | True_only | Specifies the row or rows to be altered |
row_range | Integer | Specifies the range of rows to be altered |
column_range | Integer | Specifies the range of columns to be altered |
order | Matrix_input_order | Specifies the of ascending/ descending arrangement of cell content |
repeat_strings | Boolean | Specifies the whether strings in the cell to be repeated |
strings | String | Specifies the string to be appended |
reals | Real | Specifies the REAL value to be inserted |
action | Col_action | Specifies the insertion point of the string or reals |
execute | Boolean | Specifies if the command is to be executed or not on cell change |
Extended Definition:
1. The contents of an existing cell of a data table can be altered using the ‘SET’ command. The cells which will be altered can be specified by multiple – mutually exclusive – choices like ‘use_cell_selected’, ‘use_row_selected’, ‘row_range’, or ‘column _range’. The parameters ‘use_row_selected’ and ‘use_cells_selected’ can directly indicate the row or cells to be affected. Alternatively, the range of cell or rows can be entered in the ‘row_range’ and column_range’ parameters. The order of the resulting rows or columns can be set by the parameter ‘order’, which specifies whether the result set component is to be listed in ascending or descending order. If entered, this parameter is used regardless of whether the values are to be printed to the terminal or to a file. This parameter is optional and if not entered, it will default to "ascending" order. The two values for the ORDER parameter are ‘by_row’ and ‘by_column’, which specifies whether the column or the row is to be arranged in order.
2. If the cell contains the same strings or reals as the one to be entered after alteration, then whether the strings is to be repeated or not is decided by the parameter ‘repeat_strings’. If the ‘repeat strings’ is set to ‘yes’ then all the rows in the column will be replaced by new contents. On the other hand, if the ‘repeat_strings’ is set to ‘no’, then only first row of the column will be replaced by the new contents.
3. The parameter ‘string’ or ‘real’ is used to specify the new contents of the cell which may replace, append or prefix the existing contents of the cell. To specify how the new contents would be inserted in the existing cell contents, the parameter ‘action’ which has multiple options like ‘replace’, ‘append’, or ‘prefix’ is used.
4. The parameters ‘execute’ specify if the ‘command’ specified in data_table create interface is to be executed or not on each cell change.
Tips:
The parameters ‘use_row_selected’ and ‘row_range’ are mutually exclusive.