Table of Contents
- Introduction
- Tutorials
- Introduction to Tutorials
- FlexSim Basics Tutorials
- FlexSim Healthcare Tutorial
- Task Logic Tutorials
- Process Flow Tutorials
- Additional Tools Tutorials
- Tutorial 1 - Conveyors
- Tutorial 2 - The Statistics Collector
- Tutorial 2 Overview
- 2.1 - Build an Average Content Collector
- 2.2 - Build an Output Collector
- 2.3 - Build a Content Over Time Collector
- 2.4 - Build an Orders In Progress Collector
- 2.5 - Build and Orders By Size Collector
- 2.6 - Build a Pick Time By Type Collector
- 2.7 - Build an Average Content By Type Collector
- 2.8 - Build a Content By Type Over Time Collector
- 2.9 - Build an Output By Hour By Type Collector
- Tutorial 3 - Emulation
- Tutorial 4 - Experimenter / Optimizer
- The FlexSim User Interface
- Simulation Best Practices
- Using 3D Objects
- Connecting 3D Object Flows
- Building the Model's Logic
- Working With Task Executers
- Getting Data from Your Model
- Using FlexSim Healthcare
- Reference
- System Requirements
- Release Notes and History
- General Model Settings
- 3D Objects
- Process Flow Activities and Shared Assets
- People Objects
- 3D Objects
- Process Flow Activities
- People Tables
- People Table Concepts
- Person Labels
- Person States
- Person Milestones
- Person Travel Distance
- Person Wait Times
- Census History
- Staff Groups
- Staff States
- Staff State History
- Staff Travel Distance
- Person Wait for Staff History
- Location Groups
- Location States
- Location State History
- Location Census History
- Location Staytime History
- Person Wait for Location History
- Transport Groups
- Transport States
- Transport State History
- Transport Travel Distance
- Person Wait for Transport History
- Equipment Groups
- Equipment States
- Equipment State History
- Equipment Travel Distance
- Person Wait for Equipment History
- Line Census History
- Line Staytime History
- People Templates
- People Template Concepts
- Person Templates
- Average Staytime Bar
- Staytime Box Plot
- Average Milestone Times Bar
- Average Milestone-Milestone Times Bar
- Milestone-Milestone Times Box Plot
- Average Time in State Table
- Average Time in State Pie
- Average Time in State Bar
- Average Distance Table
- Average Distance Bar
- Average Wait Times Table
- Average Wait Times Bar
- Census Bar
- Census vs Time
- Model Throughput Table
- Model Throughput Bar
- Staff Templates
- Staff State Templates
- Staff Avg State Table
- Staff Avg State Pie
- Staff Avg State Bar
- Staff Avg State (Availability) Table
- Staff Avg State (Availability) Pie
- Staff Avg State (Availability) Bar
- Staff Avg State (Combined) Table
- Staff Avg State (Combined) Pie
- Staff Avg State (Combined) Bar
- Staff Utilization (Combined) Box Plot
- Location Templates
- Location State Templates
- Location Avg State Table
- Location Avg State Pie
- Location Avg State Bar
- Location Avg State (Availability) Table
- Location Avg State (Availability) Pie
- Location Avg State (Availability) Bar
- Location Avg State (Combined) Table
- Location Avg State (Combined) Pie
- Location Avg State (Combined) Bar
- Location Utilization (Combined) Box Plot
- Waiting Line Templates
- People Settings
- Tools
- Properties Panels
- Task Sequences
- Tools
- Agent System Tool
- AGV Network Tool
- A* Navigation
- Calculated Table
- Code Editor
- Color Palettes
- Conveyor System Tool
- Database Connectors
- Down Behaviors
- Edit Selected Objects Tool
- Empirical Distribution
- Emulation
- Event List
- Event Log
- Excel Interface
- Experimenter and Optimizer
- Find Objects Tool
- Global Lists
- Global Tables
- Global Variables
- Groups
- Lights
- Measure and Convert Tool
- Memory Profiler
- Milestone Collector
- Model Triggers
- Model Parameter Tables
- MTBF/MTTR
- Performance Measure Tables
- Performance Profiler
- Presentation Builder
- Process Flow Variables
- Property Tables
- Script Console
- Simulation Control Bar
- Statistics Collector
- Storage System
- Time Tables
- Tracked Variables
- User Commands
- User Events
- Video Recorder
- Visio Importer
- Web Pages
- Legacy Tools
- Dashboard
- Charts
- Chart Templates
- Chart Templates
- WIP Templates
- Throughput Templates
- Throughput Table
- Throughput Bar
- Throughput per Hour Table
- Throughput per Hour Bar
- Throughput per Hour vs Time
- Composite Throughput Table
- Composite Throughput Bar
- Composite Throughput per Hour Table
- Composite Throughput per Hour Bar
- Composite Throughput per Hour vs Time
- Throughput by Type Table
- Throughput by Type Bar
- Throughput per Hour by Type Table
- Throughput per Hour by Type Bar
- Throughput per Hour by Type vs Time
- Staytime Templates
- Staytime Table
- Staytime Bar
- Staytime Per Hour
- Staytime vs Time
- Staytime Histogram
- Composite Staytime Table
- Composite Staytime Bar
- Composite Staytime per Hour vs Time
- Composite Staytime vs Time
- Composite Staytime Histogram
- Staytime by Type Table
- Staytime by Type Bar
- Staytime per Hour by Type vs Time
- Staytime by Type vs Time
- Staytime By Type Histogram
- Item Trace Gantt
- State Templates
- Zone Templates
- Milestone Templates
- Travel Distance Templates
- Widgets
- Coding in FlexSim
- Writing Logic in FlexSim
- Basic Modeling Functions
- Debugging
- Essential FlexScript Class Reference
- Full FlexScript Class Reference
- Command Reference
- Developer and Advanced User Reference
- Modules
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
Do no remove, this fixes the anchor on doc.flexsim.com
StatisticsCollector.CollectedData.colNum
readonly int colNum
Description
The position of the current column in the table.
Do no remove, this fixes the anchor on doc.flexsim.com
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.Do no remove, this fixes the anchor on doc.flexsim.com
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.Do no remove, this fixes the anchor on doc.flexsim.com
StatisticsCollector.CollectedData.currentValue
readonly Variant currentValue
Description
The value in the table at the current row and column.
Do no remove, this fixes the anchor on doc.flexsim.com
StatisticsCollector.CollectedData.eventName
readonly string eventName
Description
The name of the event that fired, causing the current callback to be evaluated.
Do no remove, this fixes the anchor on doc.flexsim.com
StatisticsCollector.CollectedData.eventNode
readonly treenode eventNode
Description
The treenode responsible for the event that fired, causing the current callback to be evaluated.
Do no remove, this fixes the anchor on doc.flexsim.com
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.Do no remove, this fixes the anchor on doc.flexsim.com
StatisticsCollector.CollectedData.linkedColumns
readonly Array linkedColumns
Description
An array of column numbers, indicating which columns are linked to the current event.
Do no remove, this fixes the anchor on doc.flexsim.com
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.Do no remove, this fixes the anchor on doc.flexsim.com
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;Model.time - data.row.RowAddTimeDo no remove, this fixes the anchor on doc.flexsim.com
StatisticsCollector.CollectedData.rowNum
readonly int rowNum
Description
The position of the current row in the table.
Do no remove, this fixes the anchor on doc.flexsim.com
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.Do no remove, this fixes the anchor on doc.flexsim.com
StatisticsCollector.CollectedData.rowValueIndex
readonly int rowValueIndex
Description
The index of this row value, if the Row Value for the current event is an Array.
Do no remove, this fixes the anchor on doc.flexsim.com
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.