The MeqHistoryCollect node collects components of its child result into a "history list". For every Result received, a hierarchical index is applied to extract a component of the Result (e.g., the main value Vells of the first VellSet) and add it to an internal list. The history list may then be accessed via the node's Result (in a format compatible with MeqDataCollect).
A MeqHistoryCollect must have exactly one child.
The following state record fields are used:
input_index determines which Result component to use. This is a HIID. The default setting of `"VellSets/0/Value" corresponds to the main value of the first VellSet.
max_list_size determines the maximum history size. If <= 0 (default), size is unlimited.
verbose determines when the history list is returned. When false (the default), history is returned only when the Request contains a Get.History command. When true, history is returned with every result.
top_label like MeqDataCollect, determines the field into which the history list is placed in the output Result. The default is "history". The history list is placed into result.top_label.value.
history_list is where the history list is kept. You can clear history by assigning an empty list ("[]" in Python) to this field.
The following Request rider commands are recognized:
Get.History=true causes the current history list to be returned.
Clear.History=true clears the history list. Note that if both commands are present, the history will be returned before being cleared.