56 lines
3.3 KiB
Markdown
56 lines
3.3 KiB
Markdown
---
|
|
source_files:
|
|
- DTS Viewer/DTS.Viewer.Modules/DTS.Viewer.TestModification/View/TestModificationView.xaml.cs
|
|
generated_at: "2026-04-16T11:09:12.708524+00:00"
|
|
model: "zai-org/GLM-5-FP8"
|
|
schema_version: 1
|
|
sha256: "3165a969f0d942bf"
|
|
---
|
|
|
|
# Documentation: TestModificationView
|
|
|
|
## 1. Purpose
|
|
|
|
`TestModificationView` is a WPF user control that provides the interaction logic for a view related to test modification functionality. It implements the `ITestModificationView` interface and exposes available filter classes (CFC - Channel Filter Classes) for use in the UI, specifically retrieving filter options from `AnalogSettingDefaults`. The module appears to be part of a larger sensor data viewing and modification system within the DTS Viewer application.
|
|
|
|
## 2. Public Interface
|
|
|
|
### `TestModificationView()` (Constructor)
|
|
**Signature:** `public TestModificationView()`
|
|
|
|
Initializes a new instance of the view by calling `InitializeComponent()`, which loads the XAML-defined UI components.
|
|
|
|
---
|
|
|
|
### `AvailableCFC` (Property)
|
|
**Signature:** `public List<IFilterClass> AvailableCFC { get; }`
|
|
|
|
**Behavior:** Returns a list of available filter classes by instantiating a new `AnalogSettingDefaults` object and accessing its `FilterOptions` property. This property is read-only (getter only). The comment references "FB 13120" indicating this was implemented for a specific feature request or bug fix.
|
|
|
|
## 3. Invariants
|
|
|
|
- The `AvailableCFC` property will never return `null` (assuming `AnalogSettingDefaults.FilterOptions` never returns `null`).
|
|
- Each call to `AvailableCFC` creates a new `AnalogSettingDefaults` instance; the property does not cache or reuse a single instance.
|
|
- The view must be initialized via `InitializeComponent()` before any UI element access.
|
|
|
|
## 4. Dependencies
|
|
|
|
### This module depends on:
|
|
- `DTS.Common.Interface` - Provides `ITestModificationView` interface that this class implements
|
|
- `DTS.Common.Interface.Sensors.SoftwareFilters` - Provides `IFilterClass` interface used in the `AvailableCFC` property return type
|
|
- `DTS.SensorDB` - Provides `AnalogSettingDefaults` class used to retrieve filter options
|
|
- `System.Windows.Controls` - WPF base classes (UserControl, inferred from partial class pattern)
|
|
- `System.Collections.Generic` - Provides `List<T>` collection type
|
|
|
|
### What depends on this module:
|
|
- Cannot be determined from source alone. Consumers would be modules that reference `ITestModificationView` or directly instantiate `TestModificationView`.
|
|
|
|
## 5. Gotchas
|
|
|
|
1. **Unused import:** `System.Text.RegularExpressions` is imported but never used in this file. This may indicate leftover code from refactoring.
|
|
|
|
2. **Namespace suppression:** The file includes `// ReSharper disable CheckNamespace`, suggesting the namespace `DTS.Viewer.TestModification` may not match the project's folder structure conventions, or ReSharper is flagging a namespace mismatch.
|
|
|
|
3. **Property allocation pattern:** The `AvailableCFC` property instantiates a new `AnalogSettingDefaults` object on every access. If called frequently (e.g., in a binding or loop), this could create unnecessary object allocations. Consider whether caching would be appropriate.
|
|
|
|
4. **FB 13120 reference:** The comment references a tracking identifier (likely FogBugz or similar issue tracker). The context and resolution of this issue are not documented in code. |