init
This commit is contained in:
54
docs/ai/Common/DTS.CommonCore/Interface/SystemSettings/DB.md
Normal file
54
docs/ai/Common/DTS.CommonCore/Interface/SystemSettings/DB.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/DB/IDBImportView.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/DB/IDBExportView.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/DB/IDBViewModel.cs
|
||||
generated_at: "2026-04-17T16:03:49.803164+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "667d7692a722816c"
|
||||
---
|
||||
|
||||
# DB
|
||||
|
||||
### Purpose
|
||||
This module defines the contract for database import/export functionality within the system settings. It provides interfaces for views and view models that handle importing data from files and exporting data to XML-formatted files, following the MVVM pattern established in the codebase.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**IDBImportView**
|
||||
- Signature: `public interface IDBImportView : IBaseView`
|
||||
- Description: Marker interface for database import views. Inherits from `IBaseView` but defines no additional members.
|
||||
|
||||
**IDBExportView**
|
||||
- Signature: `public interface IDBExportView : IBaseView`
|
||||
- Description: Marker interface for database export views. Inherits from `IBaseView` but defines no additional members.
|
||||
|
||||
**IDBViewModel**
|
||||
- Signature: `public interface IDBViewModel : IBaseViewModel`
|
||||
- Description: View model interface for coordinating database import/export operations.
|
||||
- Properties:
|
||||
- `IDBImportView ImportView { get; set; }` - The import view instance.
|
||||
- `IDBExportView ExportView { get; set; }` - The export view instance.
|
||||
- `string ImportFileName { get; set; }` - File name to import from.
|
||||
- `string ImportStatusText { get; set; }` - Status text for import operations.
|
||||
- `string ExportFileName { get; set; }` - File name to export to.
|
||||
- `string ExportData { get; set; }` - Formatted XML string to write to the export file.
|
||||
- `string ImportData { get; set; }` - Formatted XML string read from the import file.
|
||||
- Methods:
|
||||
- `void Export()` - Exports `ExportData` to `ExportFileName`.
|
||||
|
||||
### Invariants
|
||||
- `IDBViewModel` must have valid `ImportView` and `ExportView` instances before performing import/export operations.
|
||||
- `ExportFileName` must be set before calling `Export()`.
|
||||
- `ExportData` must contain valid XML content before calling `Export()`.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on**: `DTS.Common.Base` (for `IBaseView` and `IBaseViewModel`).
|
||||
- **Depended on by**: Unknown from source alone (likely concrete implementations in system settings modules).
|
||||
|
||||
### Gotchas
|
||||
- The XML comments indicate uncertainty about whether `ImportFileName` and `ExportFileName` properties belong in the view model, suggesting potential refactoring may be needed if the view model becomes capable of handling all operations independently.
|
||||
- The current implementation uses XML strings for data transfer; the comment "for now this is formatted xml string" suggests this may change in future versions.
|
||||
|
||||
---
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/ISOSettings/IisoSettingsView.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/ISOSettings/IISOSettingsModel.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/ISOSettings/IISOSettingsViewModel.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/ISOSettings/IISOSettingsData.cs
|
||||
generated_at: "2026-04-17T16:34:44.854666+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "3d98d74070b2f807"
|
||||
---
|
||||
|
||||
# Documentation: ISO Settings Interfaces
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines the contract interfaces for an ISO Settings feature implemented using the Model-View-ViewModel (MVVM) architectural pattern. It provides the abstraction layer for managing ISO-related configuration data, including view mode settings, code display preferences, and helper visibility options. The interfaces establish the boundaries between the view layer, the view model, the model, and the data structure, enabling loose coupling and testability within the DTS system settings subsystem.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `IISOSettingsView`
|
||||
**Namespace:** `DTS.Common.Interface`
|
||||
**Inherits:** `IBaseView`
|
||||
|
||||
An empty marker interface representing the view contract for ISO settings. No members are defined beyond the inherited `IBaseView`.
|
||||
|
||||
---
|
||||
|
||||
### `IISOSettingsModel`
|
||||
**Namespace:** `DTS.Common.Interface`
|
||||
**Inherits:** `IBaseModel`
|
||||
|
||||
Defines the data persistence contract for ISO settings.
|
||||
|
||||
| Method | Signature | Description |
|
||||
|--------|-----------|-------------|
|
||||
| `SaveData` | `void SaveData(IISOSettingsData data)` | Persists the provided ISO settings data. |
|
||||
| `LoadData` | `IISOSettingsData LoadData()` | Retrieves and returns the stored ISO settings data. |
|
||||
|
||||
---
|
||||
|
||||
### `IISOSettingsViewModel`
|
||||
**Namespace:** `DTS.Common.Interface`
|
||||
**Inherits:** `IBaseViewModel`
|
||||
|
||||
Defines the view model contract that mediates between the view and model.
|
||||
|
||||
| Property | Type | Access | Description |
|
||||
|----------|------|--------|-------------|
|
||||
| `View` | `IISOSettingsView` | get; set; | Reference to the associated view instance. |
|
||||
| `ISOData` | `IISOSettingsData` | get; set; | The ISO settings data being managed. |
|
||||
| `Model` | `IISOSettingsModel` | get; set; | Reference to the model for data operations. |
|
||||
|
||||
---
|
||||
|
||||
### `IISOSettingsData`
|
||||
**Namespace:** `DTS.Common.Interface`
|
||||
**Inherits:** `IBaseClass`
|
||||
|
||||
Defines the data structure contract for ISO settings configuration.
|
||||
|
||||
| Property | Type | Access | Description |
|
||||
|----------|------|--------|-------------|
|
||||
| `UniqueISOCodesRequired
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/PowerAndBattery/IPowerAndBatteryView.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/PowerAndBattery/IPowerAndBatteryViewModel.cs
|
||||
generated_at: "2026-04-17T16:36:41.032100+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "b5ce5cbdb3b9608c"
|
||||
---
|
||||
|
||||
# Documentation: Power and Battery View/ViewModel Interfaces
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines two marker interfaces—`IPowerAndBatteryView` and `IPowerAndBatteryViewModel`—that establish type identity for the Power and Battery settings feature within an MVVM (Model-View-ViewModel) architecture. These interfaces exist to provide compile-time type safety and dependency injection resolution for views and view models specifically handling power and battery system configuration, while inheriting base contracts from the framework's core abstractions.
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `IPowerAndBatteryView`
|
||||
- **Namespace:** `DTS.Common.Interface`
|
||||
- **Signature:** `public interface IPowerAndBatteryView : IBaseView { }`
|
||||
- **Description:** Marker interface for Power and Battery settings views. Inherits from `IBaseView` but defines no additional members.
|
||||
|
||||
### `IPowerAndBatteryViewModel`
|
||||
- **Namespace:** `DTS.Common.Interface`
|
||||
- **Signature:** `public interface IPowerAndBatteryViewModel : IBaseViewModel { }`
|
||||
- **Description:** Marker interface for Power and Battery settings view models. Inherits from `IBaseViewModel` but defines no additional members.
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- Both interfaces are empty marker interfaces; they define no members of their own.
|
||||
- `IPowerAndBatteryView` must always inherit from `IBaseView`.
|
||||
- `IPowerAndBatteryViewModel` must always inherit from `IBaseViewModel`.
|
||||
- The pairing of these interfaces implies a 1:1 relationship between a view and its corresponding view model in the Power and Battery feature area.
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
### This module depends on:
|
||||
- `DTS.Common.Base` — Provides `IBaseView` and `IBaseViewModel` base interfaces.
|
||||
|
||||
### What depends on this module:
|
||||
- **Unclear from source alone.** Concrete implementations of these interfaces would exist elsewhere in the codebase, likely in Power and Battery feature modules, but no such implementations are present in the provided files.
|
||||
|
||||
## 5. Gotchas
|
||||
|
||||
- **Empty marker interfaces:** Neither interface defines any members. All behavior contracts come from `IBaseView` and `IBaseViewModel`. Developers should consult those base interfaces to understand the actual API surface.
|
||||
- **Naming convention:** The interfaces follow a naming pattern suggesting they are part of a larger `SystemSettings` feature area, but the namespace `DTS.Common.Interface` does not reflect this hierarchy—the folder structure (`SystemSettings/PowerAndBattery/`) suggests organizational intent not mirrored in the namespace.
|
||||
- **Purpose unclear without context:** Without seeing `IBaseView` and `IBaseViewModel`, or any consuming code, the specific runtime behavior or registration patterns (e.g., DI container configuration) cannot be determined.
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/QASettings/IQASettingsView.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/QASettings/IQASettingsViewModel.cs
|
||||
generated_at: "2026-04-17T16:05:24.632800+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "8ce557777591eef0"
|
||||
---
|
||||
|
||||
# QASettings
|
||||
|
||||
### Purpose
|
||||
This module defines the view and ViewModel interfaces for QA (Quality Assurance) Settings functionality within the system settings. It follows the MVVM pattern, providing contract definitions that allow decoupling between the UI layer and business logic for QA-specific configuration views.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**`IQASettingsView`** (interface)
|
||||
- Inherits from: `IBaseView`
|
||||
- No additional members defined beyond the base interface.
|
||||
- Serves as a marker/contract interface for QA Settings views.
|
||||
|
||||
**`IQASettingsViewModel`** (interface)
|
||||
- Inherits from: `IBaseViewModel`
|
||||
- No additional members defined beyond the base interface.
|
||||
- Serves as a marker/contract interface for QA Settings ViewModels.
|
||||
|
||||
### Invariants
|
||||
- Both interfaces must inherit from their respective base types (`IBaseView` and `IBaseViewModel`) from `DTS.Common.Base`.
|
||||
- Implementations of `IQASettingsView` must be compatible with the MVVM infrastructure defined by `IBaseView`.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on**: `DTS.Common.Base` (specifically `IBaseView` and `IBaseViewModel`)
|
||||
- **Depended on by**: Cannot be determined from source alone; likely consumed by concrete View/ViewModel implementations and DI containers.
|
||||
|
||||
### Gotchas
|
||||
- Both interfaces are empty marker interfaces. It is unclear from source alone whether this is intentional (for type discrimination) or incomplete implementation. Developers should check for extension methods or base class behaviors that may provide actual functionality.
|
||||
|
||||
---
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/RealtimeSettings/IRealtimeSettingsView.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/RealtimeSettings/IRealtimeSettingsViewModel.cs
|
||||
generated_at: "2026-04-17T16:05:24.634187+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "f67c020c26fbafd0"
|
||||
---
|
||||
|
||||
# RealtimeSettings
|
||||
|
||||
### Purpose
|
||||
This module defines the view and ViewModel interfaces for Realtime Settings functionality within the system settings. It provides MVVM contract definitions for configuring real-time data processing or display settings.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**`IRealtimeSettingsView`** (interface)
|
||||
- Inherits from: `IBaseView`
|
||||
- No additional members defined beyond the base interface.
|
||||
- Serves as a marker/contract interface for Realtime Settings views.
|
||||
|
||||
**`IRealtimeSettingsViewModel`** (interface)
|
||||
- Inherits from: `IBaseViewModel`
|
||||
- No additional members defined beyond the base interface.
|
||||
- Serves as a marker/contract interface for Realtime Settings ViewModels.
|
||||
|
||||
### Invariants
|
||||
- Both interfaces must inherit from their respective base types (`IBaseView` and `IBaseViewModel`) from `DTS.Common.Base`.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on**: `DTS.Common.Base` (specifically `IBaseView` and `IBaseViewModel`)
|
||||
- **Depended on by**: Cannot be determined from source alone.
|
||||
|
||||
### Gotchas
|
||||
- Both interfaces are empty marker interfaces. The absence of any Realtime-specific members suggests either type-only discrimination or an incomplete API surface. Verify against concrete implementations before extending.
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/TablesSettings/ITablesSettingsView.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/TablesSettings/ITablesSettingsModel.cs
|
||||
generated_at: "2026-04-17T16:24:10.492908+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "1f1cdb1a5b001763"
|
||||
---
|
||||
|
||||
# TablesSettings
|
||||
|
||||
### Purpose
|
||||
This module defines the contract for the Tables Settings feature within the System Settings subsystem. It provides marker interfaces for the View and ViewModel components following the Model-View-ViewModel (MVVM) pattern, enabling decoupled UI implementation for table configuration management.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**ITablesSettingsView** (extends `IBaseView`)
|
||||
- Marker interface with no additional members.
|
||||
- Represents the view contract for table settings UI.
|
||||
|
||||
**ITablesSettingsViewModel** (extends `IBaseViewModel`)
|
||||
- Marker interface with no additional members.
|
||||
- Represents the ViewModel contract for table settings logic and state.
|
||||
|
||||
### Invariants
|
||||
- Both interfaces must be implemented by concrete types that also satisfy the contracts of `IBaseView` and `IBaseViewModel` respectively.
|
||||
- The View and ViewModel are expected to be paired together in the dependency injection container.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on:** `DTS.Common.Base` (specifically `IBaseView` and `IBaseViewModel`)
|
||||
- **Depended on by:** Unknown from source alone (likely concrete implementations in UI/presentation layers)
|
||||
|
||||
### Gotchas
|
||||
None identified from source alone. The interfaces are empty marker interfaces, suggesting either a work-in-progress feature or a design where all behavior is defined in the base interfaces.
|
||||
|
||||
---
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/TestSettings/ITestSettingsView.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/TestSettings/ITestSettingsViewModel.cs
|
||||
generated_at: "2026-04-17T16:24:10.493233+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "478d564fcaa4de16"
|
||||
---
|
||||
|
||||
# TestSettings
|
||||
|
||||
### Purpose
|
||||
This module defines the contract for the Test Settings feature within the System Settings subsystem. It provides marker interfaces for the View and ViewModel components following the MVVM pattern, enabling decoupled UI implementation for test configuration management.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**ITestSettingsView** (extends `IBaseView`)
|
||||
- Marker interface with no additional members.
|
||||
- Represents the view contract for test settings UI.
|
||||
|
||||
**ITestSettingsViewModel** (extends `IBaseViewModel`)
|
||||
- Marker interface with no additional members.
|
||||
- Represents the ViewModel contract for test settings logic and state.
|
||||
|
||||
### Invariants
|
||||
- Both interfaces must be implemented by concrete types that also satisfy the contracts of `IBaseView` and `IBaseViewModel` respectively.
|
||||
- The View and ViewModel are expected to be paired together in the dependency injection container.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on:** `DTS.Common.Base` (specifically `IBaseView` and `IBaseViewModel`)
|
||||
- **Depended on by:** Unknown from source alone (likely concrete implementations in UI/presentation layers)
|
||||
|
||||
### Gotchas
|
||||
None identified from source alone. Similar to TablesSettings, these are empty marker interfaces.
|
||||
|
||||
---
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/UISettings/IUISettingsView.cs
|
||||
- Common/DTS.CommonCore/Interface/SystemSettings/UISettings/IUISettingsViewModel.cs
|
||||
generated_at: "2026-04-17T16:36:39.195802+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "1ddea72e8e683afa"
|
||||
---
|
||||
|
||||
# Documentation: UI Settings Interfaces
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines two marker interfaces, `IUISettingsView` and `IUISettingsViewModel`, which establish type identity for the View and ViewModel components of a UI Settings feature within an MVVM (Model-View-ViewModel) architecture. These interfaces serve as extension points in the `DTS.Common.Interface` namespace, allowing concrete implementations to be identified and potentially resolved by the system's view/view-model infrastructure.
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `IUISettingsView`
|
||||
- **Namespace:** `DTS.Common.Interface`
|
||||
- **Declaration:** `public interface IUISettingsView : IBaseView { }`
|
||||
- **Description:** An empty marker interface extending `IBaseView`. Intended to be implemented by UI components responsible for displaying or editing user interface settings.
|
||||
|
||||
### `IUISettingsViewModel`
|
||||
- **Namespace:** `DTS.Common.Interface`
|
||||
- **Declaration:** `public interface IUISettingsViewModel : IBaseViewModel { }`
|
||||
- **Description:** An empty marker interface extending `IBaseViewModel`. Intended to be implemented by view model classes that manage the state and behavior logic for UI settings.
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- Both interfaces must inherit from their respective base contracts (`IBaseView` and `IBaseViewModel`), implying any implementing class must satisfy the contracts defined by those base types.
|
||||
- The interfaces define no additional members, so all behavioral contracts are inherited from the base interfaces in `DTS.Common.Base`.
|
||||
- **Unclear from source:** The specific invariants enforced by `IBaseView` and `IBaseViewModel` cannot be determined from the provided source files.
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
### This module depends on:
|
||||
- `DTS.Common.Base` — Provides `IBaseView` and `IBaseViewModel` base interfaces.
|
||||
|
||||
### What depends on this module:
|
||||
- **Unclear from source alone.** No imports or consumers are visible in the provided files. Likely consumers would include concrete View and ViewModel implementations for UI settings, as well as any navigation or dependency injection infrastructure that resolves views and view models by interface type.
|
||||
|
||||
## 5. Gotchas
|
||||
|
||||
- **Empty marker interfaces:** Both `IUISettingsView` and `IUISettingsViewModel` define no members of their own. This is either an intentional design (marker pattern for type discrimination) or an incomplete implementation. Developers should verify whether additional members should be added or if the marker pattern is deliberate.
|
||||
- **Base interface contracts unknown:** Without visibility into `IBaseView` and `IBaseViewModel`, the actual responsibilities and contracts that implementers must fulfill are unclear from this source alone.
|
||||
Reference in New Issue
Block a user