34 lines
2.0 KiB
Markdown
34 lines
2.0 KiB
Markdown
|
|
---
|
||
|
|
source_files:
|
||
|
|
- DataPRO/IService/StateMachine/StatusAndParameters/Realtime/RealtimeParameters.cs
|
||
|
|
- DataPRO/IService/StateMachine/StatusAndParameters/Realtime/RealtimeStatusInformation.cs
|
||
|
|
generated_at: "2026-04-17T15:41:52.943128+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "6c622a99f8df2e9c"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: Realtime State Machine Components
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module provides the parameter configuration and status management components for a realtime data acquisition state machine. `RealtimeParameters` serves as a data transfer object holding all configuration needed to initiate realtime polling operations across DAS (Data Acquisition System) hardware units. `RealtimeStatusInformation` manages the runtime state of realtime operations, including thread synchronization primitives, callback handling, and the orchestration of starting/stopping realtime data collection via the `RealtimeService`.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### RealtimeParameters (implements `IStatusParameters`)
|
||
|
|
|
||
|
|
| Member | Signature | Description |
|
||
|
|
|--------|-----------|-------------|
|
||
|
|
| `UnitsToStartRealtime` | `List<IDASCommunication>` | Collection of DAS communication units to start realtime mode on. |
|
||
|
|
| `RealtimeDelayBetweenPollsInMilliSecond` | `int` | Delay interval between polling cycles in milliseconds. |
|
||
|
|
| `AllowMultipleSampleRealtime` | `bool` | Flag indicating whether multiple sample realtime mode is permitted. |
|
||
|
|
| `UseSingleSampleMode` | `bool` | Flag to enable single sample mode (uses `StartActivePolling` instead of `Start`). |
|
||
|
|
| `ModuleIndices` | `List<int>` | List of module array indices for realtime operations. |
|
||
|
|
| `IdasToActiveChannels` | `Dictionary<IDASCommunication, byte[]>` | Maps each DAS unit to its active channel configuration. |
|
||
|
|
| `RealtimeSampleRate` | `double` | Sample rate for realtime acquisition. |
|
||
|
|
| `RealtimeSampleRateAAFilterRatio` | `byte` | Ratio used to calculate Anti-Alias Filter frequency. |
|
||
|
|
| `SliceTurnOffAAFRealtime` | `bool` | Flag to disable AAF for Slice hardware during realtime. |
|
||
|
|
| `Reset()` | `
|