This commit is contained in:
2026-04-17 14:55:32 -04:00
commit bc3ac1d4c9
18017 changed files with 4371742 additions and 0 deletions

View File

@@ -0,0 +1,55 @@
---
source_files:
- Common/DTS.Common/Classes/Sensors/AnalogDiagnostics/DiagnosticRun.cs
- Common/DTS.Common/Classes/Sensors/AnalogDiagnostics/DiagnosticEntry.cs
generated_at: "2026-04-17T15:41:04.266390+00:00"
model: "zai-org/GLM-5-FP8"
schema_version: 1
sha256: "8eaedb5d34696af2"
---
# Documentation: DTS.Common.Classes.Sensors.AnalogDiagnostics
## 1. Purpose
This module provides entity classes for analog sensor diagnostics within the DTS system. It models diagnostic test runs and individual diagnostic measurements, serving as data transfer objects that map directly to database records. The classes support both programmatic instantiation and hydration from SQL query results via `SqlDataReader`, facilitating the persistence and retrieval of sensor diagnostic data such as excitation, offset, noise, and shunt measurements.
---
## 2. Public Interface
### DiagnosticRun Class
**Namespace:** `DTS.Common.Classes.Sensors.AnalogDiagnostics`
**Implements:** `IDiagnosticRun`
Represents a diagnostic test run session.
#### Constructors
| Signature | Description |
|-----------|-------------|
| `DiagnosticRun()` | Default parameterless constructor. |
| `DiagnosticRun(SqlDataReader reader)` | Constructs an instance by reading column values from the provided `SqlDataReader`. Checks for `DBNull.Value` before casting each field. |
#### Properties
| Property | Type | Default | Description |
|----------|------|---------|-------------|
| `Id` | `long?` | `null` | Unique identifier for the diagnostic run. |
| `DataPROUser` | `string` | `string.Empty` | User identifier associated with the run. |
| `TestId` | `int?` | `null` | Identifier for the test being executed. |
| `TestName` | `string` | `string.Empty` | Human-readable name of the test. |
| `PreTest` | `bool` | `true` | Indicates whether this is a pre-test diagnostic run. |
---
### DiagnosticEntry Class
**Namespace:** `DTS.Common.Classes.Sensors.AnalogDiagnostics`
**Implements:** `IDiagnosticEntry`
Represents a single diagnostic measurement entry within a `DiagnosticRun`, containing sensor channel information and multiple diagnostic measurements with their statuses.
#### Constructors

View File

@@ -0,0 +1,66 @@
---
source_files:
- Common/DTS.Common/Classes/Sensors/SensorsList/DragAndDropPayload.cs
generated_at: "2026-04-17T16:39:51.857757+00:00"
model: "zai-org/GLM-5-FP8"
schema_version: 1
sha256: "4ab602cffdf9b6ad"
---
# Documentation: DragAndDropPayload
## 1. Purpose
`DragAndDropPayload` is a data transfer object that encapsulates an array of `IDragAndDropItem` objects for drag-and-drop operations within a sensors list context. It provides format identifiers for clipboard/drag-drop data interchange, with distinct constants for standard, ALT-modified, and CTRL-modified drop operations.
## 2. Public Interface
### Class: `DragAndDropPayload`
**Namespace:** `DTS.Common.Classes.Sensors.SensorsList`
#### Constructor
```csharp
public DragAndDropPayload(IDragAndDropItem[] items)
```
Creates a new payload containing the provided items. Assigns the `items` array directly to the `Items` property.
#### Properties
```csharp
public IDragAndDropItem[] Items { get; }
```
Read-only property returning the array of drag-and-drop items. No setter is exposed.
#### Constants
| Constant | Value |
|----------|-------|
| `FORMAT` | `"DTS.Common.Classes.Sensors.SensorsList.DragAndDropPayload"` |
| `ALT_FORMAT` | `"ALT_DTS.Common.Classes.Sensors.SensorsList.DragAndDropPayload"` |
| `CTRL_FORMAT` | `"CTRL_DTS.Common.Classes.Sensors.SensorsList.DragAndDropPayload"` |
These constants are intended for use as format strings in drag-and-drop or clipboard operations, distinguishing between unmodified, ALT-modified, and CTRL-modified drop actions.
## 3. Invariants
- The `Items` array reference is immutable after construction (no setter exposed).
- The format constants are compile-time constants and cannot be modified at runtime.
- **Note:** The source does not indicate whether null values are permitted for the `items` parameter or elements within the array.
## 4. Dependencies
**This module depends on:**
- `DTS.Common.Interface.Sensors.SensorsList.IDragAndDropItem` — interface type used for items in the payload.
**What depends on this module:**
- Not determinable from the source alone. Consumers would typically be UI components handling drag-and-drop operations for sensor lists.
## 5. Gotchas
- **No defensive copying:** The constructor assigns the input array directly to `Items` without copying. Callers retaining a reference to the passed array can mutate its contents after construction.
- **No null validation:** The source contains no null checks. Passing `null` to the constructor will result in `Items` being `null`.
- **Format string naming:** The format constants embed the full namespace path. If the class is refactored to a different namespace, these strings would need manual updating to remain consistent with any external systems expecting specific format identifiers.

View File

@@ -0,0 +1,25 @@
---
source_files:
- Common/DTS.Common/Classes/Sensors/StreamOut/UDPStreamProfilePacket.cs
generated_at: "2026-04-17T16:10:35.133764+00:00"
model: "zai-org/GLM-5-FP8"
schema_version: 1
sha256: "9b781bc3bbbe9743"
---
# StreamOut
### Purpose
Defines data structures for UDP streaming profile packets used in sensor data transmission. This module provides configuration containers that specify header, timing, and payload parameters for formatting sensor data streams over UDP.
### Public Interface
**`UDPStreamProfilePacket` (class)**
- A POCO (Plain Old CLR Object) containing configuration properties for UDP stream packet formatting.
**Properties (all public get/set):**
- `int TransHeader` - Default: 4. Transaction header configuration.
- `int TimeHeader` - Default: 24. Time header configuration.
- `int SecondTimeHeader` - Default: 0. Secondary time header configuration.
- `int ChannelSpecificDataWord` - Default: 0. Channel-specific data word.
- `int PCM