RiverWare 6.2: Gridded Object Data Editor / Analysis
CADSWES / Phil Weinstein / 10-27-2011

Note (11-01-2011):  TODO -- Reframe this feature as an SCT tab. A single, unnamed Gridded Object Data Editor configuration will be associated with each SCT. Gridded Object Data Editors will not be managed in any other way, e.g. not as named items in a RiverWare model.

Draft Reqiurements Overview

This new feature presents a grid of simulation objects (generally, spacially related).

1. Basic Requirements:

1. The user assigns one simulation object and a small set of scalar and table slots of that object to each grid cell. (Typcially, 3 to 10 slots will be shown in each cell).
2. Each cell's object name and object type icon is always shown. (SEE MOCKUP).
3. Each cell's slots can be shown or hidden. (i.e. in each cell: all slots are shown or all are hidden). When a cell's slots are shown, the cell is described as being "Open".
4. When a cell is open, its slots are arranged in a vertical list under the object name.
5. When the height of the cell is limited to less than what is needed to show all of the cell's slots, a vertical scroll bar is shown along the right side of the cell.
6. Scalar slot and single-cell table slot items are presented with their value and scaled units.
• Displayed slot values are editable.
• Possible: Scaled units will be conditionally shown. (i.e. it will be possible to hide units). When unit display is off, scaled units will be displayed as a tooltip.
7. Other table slot items (for table slots having more than one cell) implement an operation to show the slot's Open Slot Dialog.
    
2. Configuration Operations:

1. Set the number of rows and columns.
2. Insert rows and columns.
3. Assign a simulation object to a cell.
4. Assign a set of slots from a cell's simulation object to the cell.
5. Reorder the set of slots in a cell.
6. Replicate the set of slots in one cell to the cells of different objects of the same object type. (Polymorphic support will be provided for the reservoir types).
7. Clear the simulation object or slots from a cell.
8. Possible: Remove rows and columns.
9. Possible: Move the contents of a cell to a different cell.
10. Possible: Move the contents of a row or column to a different row or column.

3. Use Operations:

1. Selectable single cells, multiple cells, or whole rows and columns.
2. Open / Close a cell.
3. Open / Close a cell and its four neighboring cells
   • Possible: Shift-click of Open Close cell button.
   • Possible: Control-click also closes all other cells.
4. Open / Close the cells in a row. This is motivated by the fact that, when a cell is open, the cell expands vertically to show the slot list. This provides unused "real estate" for the other cells in the same row -- so it would be very natural to simply open all of the cells in the row.
5. Open / Close all cells.
    
4. Adjustment Operations:

1. Adjust individual column widths and row heights manually, by dragging column and row dividers.
2. Automatically adjust column widths or row heights to the cell content.
3. Set all column widths or row heights to that of the selected cell (or column or row).
    
5. Management -- NO LONGER CORRECT -- See note above.

1. Gridded Object Data Editors (either one, or multiple) will be stored within the RiverWare model.
2. Possible: A RiverWare model will support multiple Gridded Object Data Editors, each with its own configuration.
   • Gridded Object Data Editors will be named (within the RiverWare model).
   • It will be possible to duplicate and modify an existing Gridded Object Data Editor (configuration).
   • Possible: Cell / Row/ Column copy and paste operations will be supported between distinct editors within the RiverWare session.
3. Possible: It will be possible to export and import Gridded Object Data Editor configurations to/from external files.

See also object grid mockup based on ground water objects and related reaches in an actual user model.

---