39 lines
2.0 KiB
Markdown
39 lines
2.0 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common.DataModel/Classes/TSRAIRGo/TSRAIRGoStatus.cs
|
||
|
|
generated_at: "2026-04-17T16:44:00.741985+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "b413c3f7dc7c89c9"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: TSRAIRGoStatus.cs
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines the `TSRAIRGoStatus` class, which serves as a container for the `StatusTypes` enum. This enum represents the complete lifecycle states for a TSRAIRGo hardware device (likely a Data Acquisition System or "DAS"), covering hardware discovery, connection establishment, health validation, arming/streaming operations, and data retrieval. It exists to provide a standardized, localized set of status codes that can be displayed to users via resource lookup keys.
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### Class: `TSRAIRGoStatus`
|
||
|
|
- **Namespace:** `DTS.Common.DataModel.Classes.TSRAIRGo`
|
||
|
|
- **Description:** A non-inheritable container class (implicit sealed) that exposes a single nested enum. The class itself has no instance members or methods.
|
||
|
|
|
||
|
|
### Enum: `TSRAIRGoStatus.StatusTypes`
|
||
|
|
- **Signature:** `public enum StatusTypes`
|
||
|
|
- **Type Converter:** `EnumDescriptionTypeConverterShared` (applied via `[TypeConverter]` attribute)
|
||
|
|
- **Description:** Defines 49 discrete status states for TSRAIRGo device lifecycle management. Each value (except three noted below) is decorated with a `[Description]` attribute containing a resource lookup key for UI localization.
|
||
|
|
|
||
|
|
**Enum Values (grouped by operational domain):**
|
||
|
|
|
||
|
|
| Value | Description Attribute | Notes |
|
||
|
|
|-------|----------------------|-------|
|
||
|
|
| **Discovery/Connection** | | |
|
||
|
|
| `UNKNOWN` | `"Table_NA"` | Default/unknown state |
|
||
|
|
| `PING_FAILED` | `"HardwareDiscoveryControl_PingFailed"` | |
|
||
|
|
| `PINGING` | `"AutoDetectDASControl_Pinging"` | |
|
||
|
|
| `PING_SUCCESS` | `"AutoDetectDASControl_Ping_Good"` | |
|
||
|
|
| `CONNECT_FAILED` | `"HardwareDiscoveryControl_FailedToConnect"` | |
|
||
|
|
| `CONNECTING` | `"AutoDetectDASControl_Connecting"` | |
|
||
|
|
| `QUERY_FAILED` | `"AutoDetectDASControl_QueryFailed"` | |
|
||
|
|
| `
|