init
This commit is contained in:
@@ -0,0 +1,62 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/RealtimeSettings/IRealtimeSettingsView.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/RealtimeSettings/IRealtimeSettingsViewModel.cs
|
||||
generated_at: "2026-04-16T12:20:24.412229+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "0ef736bfba716a64"
|
||||
---
|
||||
|
||||
# Documentation: IRealtimeSettingsView & IRealtimeSettingsViewModel
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines two marker interfaces—`IRealtimeSettingsView` and `IRealtimeSettingsViewModel`—for the RealtimeSettings feature within an MVVM (Model-View-ViewModel) architecture. These interfaces serve as extension points for real-time system settings configuration, allowing concrete implementations to be identified, registered, and resolved through dependency injection or convention-based wiring. The interfaces themselves are empty, indicating they rely entirely on their base contracts for behavior.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `IRealtimeSettingsView`
|
||||
- **Namespace:** `DTS.Common.Interface`
|
||||
- **Inheritance:** `IBaseView`
|
||||
- **Signature:**
|
||||
```csharp
|
||||
public interface IRealtimeSettingsView : IBaseView { }
|
||||
```
|
||||
- **Behavior:** Marker interface with no members. Any contract behavior is inherited from `IBaseView` (defined in `DTS.Common.Base`).
|
||||
|
||||
### `IRealtimeSettingsViewModel`
|
||||
- **Namespace:** `DTS.Common.Interface`
|
||||
- **Inheritance:** `IBaseViewModel`
|
||||
- **Signature:**
|
||||
```csharp
|
||||
public interface IRealtimeSettingsViewModel : IBaseViewModel { }
|
||||
```
|
||||
- **Behavior:** Marker interface with no members. Any contract behavior is inherited from `IBaseViewModel` (defined in `DTS.Common.Base`).
|
||||
|
||||
---
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- **Type hierarchy:** `IRealtimeSettingsView` must always be assignable to `IBaseView`. `IRealtimeSettingsViewModel` must always be assignable to `IBaseViewModel`.
|
||||
- **No additional contracts:** Neither interface defines additional members beyond their base interfaces. Any invariants are inherited from `IBaseView` and `IBaseViewModel`, but **these are not visible in the provided source**.
|
||||
|
||||
---
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
### This module depends on:
|
||||
- `DTS.Common.Base` — Provides `IBaseView` and `IBaseViewModel` base interfaces.
|
||||
|
||||
### What depends on this module:
|
||||
- **Unknown from source alone.** Concrete View and ViewModel implementations for RealtimeSettings would implement these interfaces, and DI containers or navigation frameworks would consume them, but no such consumers are visible in the provided files.
|
||||
|
||||
---
|
||||
|
||||
## 5. Gotchas
|
||||
|
||||
- **Marker interfaces:** Both interfaces are empty marker interfaces. Developers should not expect any RealtimeSettings-specific members here; all functionality comes from the base interfaces (`IBaseView`, `IBaseViewModel`), which are not included in the provided source.
|
||||
- **Naming suggests pairing:** The naming convention (`IRealtimeSettingsView` + `IRealtimeSettingsViewModel`) strongly implies an MVVM pairing, but the relationship is not enforced at the type level.
|
||||
- **Purpose unclear without context:** The specific behavior or data associated with "RealtimeSettings" is not documented in these interfaces. The actual settings, validation rules, or real-time update mechanisms must be defined in implementing classes or related modules not provided here.
|
||||
Reference in New Issue
Block a user