SCT: Custom Time-Aggregation Summary Rows / RiverWare 6.6
Bug Number: n/a
Release notes (y/n): Yes
For Release Nums: 6.6

See Document [10-28-2014]:
   SCT: Custom Time-Aggregation Summary Rows / RiverWare 6.6 [5 pp].
   Word: R:\doc\sct\2014\CustAggSumRows\CustAggSumRows-Oct2014.docx
   PDF: R:\doc\sct\2014\CustAggSumRows\CustAggSumRows-Oct2014-Phil-28.pdf

One of the four SCT "views" -- the time-aggregated, vertical time view (where slots are columns) -- now supports the specification of multiple custom "summary rows" at the end of each time aggregation.

The following custom summary row types are supported.

1. Divider Row (thin, with configurable color)
2. Sum
3. Average
4. Maximum
5. Minimum
6. Difference of prior two numeric rows
7. Slot Reference (described more below).

Most row types are basic statistical functions applied to the block of individual timesteps within a time aggregation. Each custom summary row can be configured with a unique background color. (This applies to divider rows as well).

The initial use case is an SCT re-implementation of TVA's "Preschedule" Excel application. This presents a daily aggregation of hourly series data. In this SCT view, the timestep rows for each time aggregation -- and the new custom summary rows associated with the aggregation -- can be shown or hidden with the treeview control (triangle arrow) in the left-most column. These treeview controls are on the originally-implemented aggregation summary rows. These support a single summary function, independently settable for each slot (display column).

The SCT's Custom Aggregation Summary Row configuration dialog box is shown using the "Aggregation >> Custom Summary Rows ..." menu operation.

Each row of controls contains at least these five columns. "Slot Reference" rows have additional controls in subsequent columns:

1. Green plus-icon button -- insert a new row, above.
2. Red minus-icon button -- delete the row.
3. Row Type -- an option menu for selecting among these different types:
   • Divider -- a thin row, without text, having a configurable color.
   • Sum -- of all timesteps in the time aggregation.
   • Average -- of all timesteps in the time aggregation
   • Maximum -- of all timesteps in the time aggregation
   • Minimum -- of all timesteps in the time aggregation
   • Difference -- of the prior two data rows.
   • Slot Reference. This resolves to either a scalar slot or a series slot having a timestep size of the timestep aggregation. (In the illustrated example, this would be a daily timestep series slot). The slot reference is composed from these pieces:
     1. The name of the Simulation Object of the column's series slot.
     2. An optional object name suffix to allow a Data Object associated with the Simulation Object to be used. If this field is specified, the algorithm attempts to locate the associated object (generally a Data Object) by name, with and without a space between the column's Simulation Object and the provided suffix.
     3. The local name of a slot.
        
4. Color -- background color. Clicking the button brings up the Windows color chooser dialog.
   
5. Label -- This will generally be terse, about the length of a timestep date and hour specification. Preschedule SCT uses will probably be: "Total", "FS Tot", "Diff", "MEL", "MSL".
   

Slot Reference rows contain the following additional control columns to identify a particular series slot (of the aggregation size) or scalar slot for each simulation object (reservoir) column. As described above, the primary reference simulation object will be the object containing the SCT column's associated series slot.

1. Data Obj Suffix -- optional object name suffix to specify a Data Object associated with the reference Simulation Object.
2. (Local) Slot Name -- the name of a slot on the reference Simulation Object or associated Data Object.
3. "Editable" checkbox to indicate if the resolved slot reference (daily series or scalar slot) is editable in the SCT.

Special Custom Summary Row / Cell Behaviors:

1. The Custom Summary Rows support only single-cell selection, and such a selection is active only if no other SCT cells are selected.
2. In the initial implementation, since the Custom Summary Row cells are primarily read-only (non-editable), the optional read-only ornamentation (cross-hatch) is not shown.
3. Custom Summary Row cells are automatically updated whenever changes to any of the other SCT cell values change. In the case of Slot Reference rows, changes to the referenced slot are also automatically reflected.
4. Slot Reference series slots don't technically need to have the aggregation's timestep size. They could have a smaller step size. In the example shown above, a Slot Reference series slot wouldn't have to have a daily timestep -- it could have an hourly, 6-hour, or 12-hour timestep. But only the values at the end of daily step boundary would be shown.
5. When entering a sequence of values in normal timestep cells, "focus" (the current cell) skips over the Custom Summary Rows, and continues within the same slot (display column) within the subsequent time aggregation.

---