StatisticsCollector.CollectedData
Description
Provides access to data that may be used in Statistics Collector callbacks.
Each StatisticsCollector has a CollectedData object. This object can only be accessed in callbacks called by the Statistics Collector, through its collectedData property. Before evaluating one of these callbacks, the Statistics Collector sets some or all of the properties on this object, so they can be read within the callback.This object also has dynamic properties, which act like labels. Event parameters and Event Data Label values are assigned as dynamic properties.
Properties
colNum | The position of the current column in the table. |
colValue | The value associated with the current column. |
colValueIndex | The index of the current column, relative to its column set. |
currentValue | The value in the table at the current row and column. |
eventName | The name of the event that fired, causing the current callback to be evaluated. |
eventNode | The treenode responsible for the event that fired, causing the current callback to be evaluated. |
group | The Group associated with the current callback. |
linkedColumns | An array of column numbers, indicating which columns are linked to the current event. |
processFlowInstance | The instance associated with the current callback. |
row | Accesses labels associated with the current row. |
rowNum | The position of the current row in the table. |
rowValue | The value associated with the current row. |
rowValueIndex | The index of this row value, if the Row Value for the current event is an Array. |
Methods
enumerate | Creates a value that represents the unique combination of object, instance, and group. |
Details
StatisticsCollector.CollectedData.colNum
readonly int colNum
Description
The position of the current column in the table.
StatisticsCollector.CollectedData.colValue
readonly Variant colValue
Description
The value associated with the current column.
This value is set as part of the Set Value callback for Column Sets.StatisticsCollector.CollectedData.colValueIndex
readonly int colValueIndex
Description
The index of the current column, relative to its column set.
This value determined by the sequence of values returned from the Set Value callback for Column Sets.StatisticsCollector.CollectedData.currentValue
readonly Variant currentValue
Description
The value in the table at the current row and column.
StatisticsCollector.CollectedData.eventName
readonly string eventName
Description
The name of the event that fired, causing the current callback to be evaluated.
StatisticsCollector.CollectedData.eventNode
readonly treenode eventNode
Description
The treenode responsible for the event that fired, causing the current callback to be evaluated.
StatisticsCollector.CollectedData.group
readonly Group group
Description
The Group associated with the current callback.
This value will be empty unless the Statistics Collector is listening to a Group, or an enumerated object is a Group.StatisticsCollector.CollectedData.linkedColumns
readonly Array linkedColumns
Description
An array of column numbers, indicating which columns are linked to the current event.
StatisticsCollector.CollectedData.processFlowInstance
readonly Object processFlowInstance
Description
The instance associated with the current callback.
This value will be empty unless the Statistics Collector is listening to, or has enumerated, a Process Flow block in a instanced flow.StatisticsCollector.CollectedData.row
readonly row
Description
Accesses labels associated with the current row.
This property is an object that has a labels property, like treenode.labels. The object also has dynamic label access, like treenode.labelProperties.For example, you could use a label to store the time a row was added in the OnRowAdding trigger:
data.row.RowAddTime = Model.time;
Then, you could reference this label in a column's value:
Model.time - data.row.RowAddTime
StatisticsCollector.CollectedData.rowNum
readonly int rowNum
Description
The position of the current row in the table.
StatisticsCollector.CollectedData.rowValue
readonly Variant rowValue
Description
The value associated with the current row.
This value is the value specified by the Row Value. If the Row Mode is Enumerate, then the row value is the object associated with the current row.StatisticsCollector.CollectedData.rowValueIndex
readonly int rowValueIndex
Description
The index of this row value, if the Row Value for the current event is an Array.
StatisticsCollector.CollectedData.enumerate()
double enumerate( ) |
double enumerate( treenode object , Object instance , Group group ) |
Parameters
object | The object to enumerate. |
instance | The instance to enumerate. |
group | The group to enumerate. |
Returns
double | A hash of the object, instance, and group values. |
Description
Creates a value that represents the unique combination of object, instance, and group.
If the parameters are not given, then the current eventNode, processFlowInstance, and group property values are used. This method creates a hash of the object, instance, and group values. That hash, along with the values used in that hash, are stored in the Statistics Collector. That hash is the return value. If you use the hash as a row value, then the Statistics Collector will assert a row for the hash value, and set eventNode, processFlowInstance, and group to the values associated with the hash.This method is most commonly used in conjunction with an Enumerate Event, allowing additional events to update rows created by the Enumerate Event. You can find additional information in the Enumerate Row Values section.