32 lines
2.2 KiB
Markdown
32 lines
2.2 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common/Interface/DASFactory/ARM/IArmStatus.cs
|
||
|
|
- Common/DTS.Common/Interface/DASFactory/ARM/IArmStatusData.cs
|
||
|
|
generated_at: "2026-04-17T16:37:47.130184+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "18c4557d1a49adee"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: DTS.Common.Interface.DASFactory.ARM
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines two interfaces for managing and representing the ARM (armed/realtime) status of DAS (Data Acquisition System) units. `IArmStatus` provides the operational interface for transitioning between arm and realtime states, querying cached status flags, and optionally persisting status to a database. `IArmStatusData` serves as the data model holding detailed state information including trigger status, recording progress, hardware metrics, and fault conditions. Together, they enable the system to track and control DAS unit operational modes throughout test execution.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### IArmStatus
|
||
|
|
|
||
|
|
| Member | Signature | Description |
|
||
|
|
|--------|-----------|-------------|
|
||
|
|
| `SetInArm` | `void SetInArm(bool WriteToDb)` | Marks the unit as being in arm mode. Optionally writes status to database based on `WriteToDb` parameter. |
|
||
|
|
| `SetInRealtime` | `void SetInRealtime(bool WriteToDb, bool ExitRealtimeIfPossible)` | Marks the unit as being in realtime mode. Optionally writes to database and can conditionally exit realtime mode. |
|
||
|
|
| `GetIsInArm` | `bool GetIsInArm()` | Returns `true` if the unit is known to be in arm state. **Does not query hardware**—returns cached flag only. |
|
||
|
|
| `GetIsInRealtime` | `bool GetIsInRealtime()` | Returns `true` if the unit is known to be in realtime state. **Does not query hardware**—returns cached flag only. |
|
||
|
|
| `GetIsStreaming` | `bool GetIsStreaming()` | Returns `true` if the unit is known to be streaming. **Does not query hardware**—returns cached flag only. |
|
||
|
|
| `DASArmStatus` | `IArmStatusData DASArmStatus { get; set; }` | Property to get or set the detailed arm status data object. |
|
||
|
|
| `SetDASArmStatus` | `void SetDASArmStatus(IArmStatusData status, bool bSetInDb)` | Sets `DASArmStatus` property and optionally persists to database. |
|
||
|
|
| `SetDASArmStatus` | `void SetDASArmStatus
|