66 lines
3.0 KiB
Markdown
66 lines
3.0 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.CommonCore/Interface/Realtime/IRealtimeChannelSelectView.cs
|
||
|
|
- Common/DTS.CommonCore/Interface/Realtime/IRealtimeChannelSelectViewModel.cs
|
||
|
|
- Common/DTS.CommonCore/Interface/Realtime/IRealtimeChannel.cs
|
||
|
|
generated_at: "2026-04-17T16:35:08.947848+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "816f2fb1c5b40348"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: DTS.Common.Interface.Realtime
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines the contract for a realtime channel selection feature within the DTS system, following the Model-View-ViewModel (MVVM) pattern. It provides interfaces for representing sensor/channel data (`IRealtimeChannel`) and the UI components for selecting channels (`IRealtimeChannelSelectView`, `IRealtimeChannelSelectViewModel`). The module abstracts the presentation layer from the underlying data model, enabling users to search and select from available realtime data channels associated with sensor hardware.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### `IRealtimeChannelSelectView`
|
||
|
|
**Namespace:** `DTS.Common.Interface.Realtime`
|
||
|
|
**Inherits:** `IBaseView`
|
||
|
|
|
||
|
|
A marker interface with no members. It serves as a typed view contract for channel selection UI components.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `IRealtimeChannelSelectViewModel`
|
||
|
|
**Namespace:** `DTS.Common.Interface.Realtime`
|
||
|
|
**Inherits:** `IBaseViewModel`
|
||
|
|
|
||
|
|
Defines the behavior for a view model that manages channel selection state.
|
||
|
|
|
||
|
|
| Member | Type | Description |
|
||
|
|
|--------|------|-------------|
|
||
|
|
| `ChannelSelectView` | `IRealtimeChannelSelectView` { get; set; } | Property to associate the view with this view model. |
|
||
|
|
| `SetAvailableChannels(IRealtimeChannel[] channels)` | `void` | Populates the view model with an array of selectable channels. |
|
||
|
|
| `SetSearchText(string searchText)` | `void` | Updates the search/filter text for narrowing the channel list. |
|
||
|
|
| `SetRealtimeChannel(IRealtimeChannel channel)` | `void` | Sets the currently selected channel. |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `IRealtimeChannel`
|
||
|
|
**Namespace:** `DTS.Common.Interface.Realtime`
|
||
|
|
|
||
|
|
Represents a realtime data channel from a sensor or data acquisition system.
|
||
|
|
|
||
|
|
| Member | Type | Description |
|
||
|
|
|--------|------|-------------|
|
||
|
|
| `Capacity` | `double` | Read-only property representing channel capacity. |
|
||
|
|
| `DisplayOrder` | `int` | Read-only property for UI sorting/ordering. |
|
||
|
|
| `SensorName` | `string` | Name of the associated sensor. |
|
||
|
|
| `ChannelName` | `string` | Name of this specific channel. |
|
||
|
|
| `DasNames` | `string[]` | Array of Data Acquisition System names. |
|
||
|
|
| `SensorSerial` | `string` | Serial number of the sensor. |
|
||
|
|
| `Units` | `string` | Measurement units. |
|
||
|
|
| `UserValue1` | `string` | User-defined value (purpose unclear from source). |
|
||
|
|
| `GroupName` | `string` | Group classification for the channel. |
|
||
|
|
| `DisplayUnit` | `string` | Units formatted for display. |
|
||
|
|
| `HardwareChannelString` | `string` | Hardware identifier string. |
|
||
|
|
| `ISOCode` | `string` | ISO standard code. |
|
||
|
|
| `SensorsString` | `string` | String representation of sensors. |
|
||
|
|
| `DasName` | `string` | Single DAS name. |
|
||
|
|
| `
|