65 lines
2.8 KiB
Markdown
65 lines
2.8 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common/Interface/DASFactory/Download/IDownloadReport.cs
|
||
|
|
- Common/DTS.Common/Interface/DASFactory/Download/IEventInfoAggregate.cs
|
||
|
|
- Common/DTS.Common/Interface/DASFactory/Download/IUARTDownload.cs
|
||
|
|
- Common/DTS.Common/Interface/DASFactory/Download/IUARTDownloadRequest.cs
|
||
|
|
- Common/DTS.Common/Interface/DASFactory/Download/IUARTEventInfo.cs
|
||
|
|
- Common/DTS.Common/Interface/DASFactory/Download/IDownloadRequest.cs
|
||
|
|
- Common/DTS.Common/Interface/DASFactory/Download/IEventInfo.cs
|
||
|
|
- Common/DTS.Common/Interface/DASFactory/Download/IDownload.cs
|
||
|
|
generated_at: "2026-04-17T15:33:30.204926+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "d5a65959da002319"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: DTS.Common.Interface.DASFactory.Download
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines the data contract interfaces for downloading event data from a Data Acquisition System (DAS). It provides abstractions for requesting data downloads (both standard and UART-based), reporting on stored events, managing event metadata including fault flags, and handling UART serial communication parameters. The interfaces serve as the boundary between the DASFactory implementation and consumers needing to retrieve recorded event data from hardware.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### IDownloadReport
|
||
|
|
Container interface for event metadata retrieved from a DAS.
|
||
|
|
|
||
|
|
| Member | Type | Description |
|
||
|
|
|--------|------|-------------|
|
||
|
|
| `Events` | `IEventInfo[]` | Array of all events stored on the DAS. |
|
||
|
|
| `UARTEvents` | `IUARTEventInfo[]` | Array of all UART events stored on the DAS. |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### IEventInfoAggregate
|
||
|
|
Aggregates multiple event info instances with summary statistics.
|
||
|
|
|
||
|
|
| Member | Type | Description |
|
||
|
|
|--------|------|-------------|
|
||
|
|
| `EventId` | `string` | Identifier for the event. |
|
||
|
|
| `EventDescription` | `string` | Text description of the event. |
|
||
|
|
| `DurationSeconds` | `double` | Duration of the event in seconds. |
|
||
|
|
| `GUID` | `string` | Globally unique identifier. |
|
||
|
|
| `HasBeenDownloaded` | `bool` | Whether the event has been downloaded. |
|
||
|
|
| `WasTriggered` | `bool` | Whether the event was triggered. |
|
||
|
|
| `NumberOfChannels` | `int` | Count of channels in the event. |
|
||
|
|
| `NumberOfSamples` | `ulong` | Total sample count. |
|
||
|
|
| `NumberOfBytes` | `ulong` | Total byte count. |
|
||
|
|
| `Faulted` | `bool` | Whether a fault occurred. |
|
||
|
|
| `EventNumber` | `int` | The event number. |
|
||
|
|
| `Add(IEventInfo newEvent)` | `void` | Adds an `IEventInfo` instance to the aggregate. |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### IDownloadRequest
|
||
|
|
Specifies parameters for a standard (non-UART) data download request.
|
||
|
|
|
||
|
|
| Member | Type | Description |
|
||
|
|
|--------|------|-------------|
|
||
|
|
| `EventNumber` | `ushort` | Target event number for download. |
|
||
|
|
| `DASChannelNumber` | `byte` | Channel number; use `ALL_CHANNELS` constant for all channels. |
|
||
|
|
| `StartSample` | `ulong` | First sample to download. |
|
||
|
|
| `
|