init
This commit is contained in:
@@ -0,0 +1,58 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/SensorDatabase/ISensorDatabaseView.cs
|
||||
- Common/DTS.CommonCore/Interface/SensorDatabase/ISensorDatabaseViewModel.cs
|
||||
generated_at: "2026-04-16T12:22:13.865366+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "9059966d6baab89c"
|
||||
---
|
||||
|
||||
# Documentation: ISensorDatabaseView and ISensorDatabaseViewModel
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines two marker interfaces—`ISensorDatabaseView` and `ISensorDatabaseViewModel`—that establish type identity for components within a sensor database feature area. These interfaces follow the Model-View-ViewModel (MVVM) pattern by inheriting from base view and view model contracts. They exist to provide type discrimination and potential future extension points for sensor database-related UI components without prescribing any specific members or behaviors at this level.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `ISensorDatabaseView`
|
||||
- **Namespace:** `DTS.Common.Interface`
|
||||
- **Declaration:** `public interface ISensorDatabaseView : IBaseView`
|
||||
- **Members:** None defined.
|
||||
- **Behavior:** Serves as a marker interface for view components associated with sensor database functionality. Inherits from `IBaseView` but adds no additional contracts.
|
||||
|
||||
### `ISensorDatabaseViewModel`
|
||||
- **Namespace:** `DTS.Common.Interface`
|
||||
- **Declaration:** `public interface ISensorDatabaseViewModel : IBaseViewModel`
|
||||
- **Members:** None defined.
|
||||
- **Behavior:** Serves as a marker interface for view model components associated with sensor database functionality. Inherits from `IBaseViewModel` but adds no additional contracts.
|
||||
|
||||
---
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- `ISensorDatabaseView` must always inherit from `IBaseView`.
|
||||
- `ISensorDatabaseViewModel` must always inherit from `IBaseViewModel`.
|
||||
- Both interfaces currently define no members, so any implementation must satisfy only the contracts of their respective base interfaces (`IBaseView` and `IBaseViewModel`).
|
||||
|
||||
**Note:** The specific invariants of `IBaseView` and `IBaseViewModel` are not visible in the provided source and cannot be documented here.
|
||||
|
||||
---
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
### This module depends on:
|
||||
- `DTS.Common.Base` — Provides `IBaseView` and `IBaseViewModel` base interfaces.
|
||||
|
||||
### What depends on this module:
|
||||
- **Unknown from source alone.** No consumers of `ISensorDatabaseView` or `ISensorDatabaseViewModel` are present in the provided files.
|
||||
|
||||
---
|
||||
|
||||
## 5. Gotchas
|
||||
|
||||
- **Empty interfaces:** Both `ISensorDatabaseView` and `ISensorDatabaseViewModel` are currently empty marker interfaces. They provide type identity but no behavioral contract. Developers should not expect any sensor-database-specific methods or properties from these interfaces alone; any such members must be defined in derived interfaces or concrete implementations.
|
||||
- **Base interface contracts unknown:** The actual requirements for implementers are determined by `IBaseView` and `IBaseViewModel`, which are not included in the provided source. Consult those definitions to understand full implementation obligations.
|
||||
Reference in New Issue
Block a user