init
This commit is contained in:
60
docs/ai/Common/DTS.CommonCore/Events/DTS.Viewer/Reports.md
Normal file
60
docs/ai/Common/DTS.CommonCore/Events/DTS.Viewer/Reports.md
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/Reports/SaveReportToCSVRequestedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/Reports/SaveReportToPDFRequestedEvent.cs
|
||||
generated_at: "2026-04-17T16:37:24.004362+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "82218c788c94f519"
|
||||
---
|
||||
|
||||
# Documentation: Report Export Events
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines two Prism event aggregation events for requesting report exports in the DTS Viewer application. `SaveReportToCSVRequestedEvent` and `SaveReportToPDFRequestedEvent` enable loosely-coupled communication between components that trigger report exports and the handlers that process them, following the event aggregator pattern from the Prism library.
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `SaveReportToCSVRequestedEvent`
|
||||
**Signature:** `public class SaveReportToCSVRequestedEvent : CompositePresentationEvent<SaveReportToCSVRequestedEventArgs>`
|
||||
|
||||
A composite presentation event that, when published, signals a request to export a report to CSV format. Subscribers receive a `SaveReportToCSVRequestedEventArgs` payload.
|
||||
|
||||
---
|
||||
|
||||
### `SaveReportToCSVRequestedEventArgs`
|
||||
**Signature:** `public class SaveReportToCSVRequestedEventArgs`
|
||||
|
||||
Payload class containing data for CSV export requests.
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `Directory` | `string` | Target directory path for the exported file. |
|
||||
| `ParentVM` | `IBaseViewModel` | Reference to the parent view model initiating the request. |
|
||||
|
||||
---
|
||||
|
||||
### `SaveReportToPDFRequestedEvent`
|
||||
**Signature:** `public class SaveReportToPDFRequestedEvent : CompositePresentationEvent<SaveReportToPDFRequestedEventArgs>`
|
||||
|
||||
A composite presentation event that, when published, signals a request to export a report to PDF format. Subscribers receive a `SaveReportToPDFRequestedEventArgs` payload.
|
||||
|
||||
---
|
||||
|
||||
### `SaveReportToPDFRequestedEventArgs`
|
||||
**Signature:** `public class SaveReportToPDFRequestedEventArgs`
|
||||
|
||||
Payload class containing data for PDF export requests.
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `Directory` | `string` | Target directory path for the exported file. |
|
||||
| `ParentVM` | `IBaseViewModel` | Reference to the parent view model initiating the request. |
|
||||
|
||||
---
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- Both event classes inherit from `CompositePresentationEvent<T>`, requiring subscribers to handle the corresponding `EventArgs` type.
|
||||
- The `Directory` property is expected to contain a
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/Reports/PowerSpectralDensity/PSDReportGRMSValuesUpdatedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/Reports/PowerSpectralDensity/PSDReportSettingsChangedEvent.cs
|
||||
generated_at: "2026-04-17T16:24:44.542867+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "39fc236fad6b3b49"
|
||||
---
|
||||
|
||||
# PowerSpectralDensity
|
||||
|
||||
### Purpose
|
||||
This module defines Prism event aggregation types for communicating changes related to Power Spectral Density (PSD) reports. It provides two event classes—`PSDReportGRMSValuesUpdatedEvent` and `PSDReportSettingsChangedEvent`—that enable loosely-coupled publication and subscription of PSD report state changes across the application, particularly for GRMS (G-RMS, likely Root Mean Square acceleration) value updates and settings model changes.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**`PSDReportGRMSValuesUpdatedEvent`**
|
||||
- Inherits from `CompositePresentationEvent<PSDReportGRMSValuesUpdatedEventArg>`
|
||||
- No additional members; serves as a typed event carrier for the Prism EventAggregator
|
||||
|
||||
**`PSDReportGRMSValuesUpdatedEventArg`**
|
||||
- `IChannelGRMSSummary[] Values` — Array of GRMS summary values (getter/setter)
|
||||
- `IBaseViewModel ParentVM` — Reference to the parent view model (getter/setter)
|
||||
|
||||
**`PSDReportSettingsChangedEvent`**
|
||||
- Inherits from `CompositePresentationEvent<PSDReportSettingsChangedEventArg>`
|
||||
- No additional members; serves as a typed event carrier for the Prism EventAggregator
|
||||
|
||||
**`PSDReportSettingsChangedEventArg`**
|
||||
- `IPSDReportSettingsModel Model` — The PSD report settings model (getter/setter)
|
||||
- `IBaseViewModel ParentVM` — Reference to the parent view model (getter/setter)
|
||||
|
||||
### Invariants
|
||||
- Event argument properties (`Values`, `Model`, `ParentVM`) are publicly settable with no null validation in the source; consumers should not assume non-null values.
|
||||
- The `Values` array in `PSDReportGRMSValuesUpdatedEventArg` may be empty but should not be assumed sorted or filtered.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on:** `DTS.Common.Base` (for `IBaseViewModel`), `DTS.Common.Interface` (for `IChannelGRMSSummary`, `IPSDReportSettingsModel`), `Microsoft.Practices.Prism.Events` (for `CompositePresentationEvent<T>`)
|
||||
- **Dependents:** Unknown from source alone; likely consumed by PSD report view models and related UI components.
|
||||
|
||||
### Gotchas
|
||||
- The event argument classes use mutable auto-properties with no constructor initialization. Callers must ensure all required properties are set before publishing.
|
||||
- The `ParentVM` property appears in both event argument types, suggesting a pattern where event handlers may need to communicate back to the originating view model, but the exact usage pattern is unclear from source alone.
|
||||
|
||||
---
|
||||
@@ -0,0 +1,83 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/TestModification/RefreshTestRequestEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/TestModification/ShowT0CursorEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/TestModification/TestModificationChangedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/TestModification/SetUseZeroForUnfilteredEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/TestModification/TestModificationEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/TestModification/ShiftT0Event.cs
|
||||
generated_at: "2026-04-17T16:03:15.424024+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "f3ae1bbc7522d687"
|
||||
---
|
||||
|
||||
# TestModification
|
||||
|
||||
### Purpose
|
||||
This module defines a set of Prism events for coordinating test modification operations within the DTS Viewer system. It provides a loosely-coupled messaging mechanism for components to communicate changes to test data, T0 cursor state, and filtering behavior without direct references. All events inherit from `CompositePresentationEvent<T>` from the legacy Microsoft.Practices.Prism library.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**RefreshTestRequestEvent**
|
||||
- Signature: `public class RefreshTestRequestEvent : CompositePresentationEvent<string>`
|
||||
- Payload: `string` (test ID)
|
||||
- Behavior: Published to request a refresh of a specific test identified by its ID.
|
||||
|
||||
**ShowT0CursorEvent**
|
||||
- Signature: `public class ShowT0CursorEvent : CompositePresentationEvent<bool>`
|
||||
- Payload: `bool` (true to show, false to hide)
|
||||
- Behavior: Controls visibility of the T0 cursor in the viewer.
|
||||
|
||||
**TestModificationChangedEvent**
|
||||
- Signature: `public class TestModificationChangedEvent : CompositePresentationEvent<ITestModificationModel>`
|
||||
- Payload: `ITestModificationModel`
|
||||
- Behavior: Notifies subscribers when the data folder or test modification model has changed.
|
||||
|
||||
**SetUseZeroForUnfilteredEvent**
|
||||
- Signature: `public class SetUseZeroForUnfilteredEvent : CompositePresentationEvent<bool>`
|
||||
- Payload: `bool`
|
||||
- Behavior: Controls whether 0 or P is used in the isocode filter field when modifying an isocode from a filter.
|
||||
|
||||
**TestModificationEvent**
|
||||
- Signature: `public class TestModificationEvent : CompositePresentationEvent<TestModificationArgs>`
|
||||
- Payload: `TestModificationArgs`
|
||||
- Behavior: Published whenever a test is modified by the viewer. Used by DataPro to regenerate an ROI when an event is modified.
|
||||
|
||||
**TestModificationArgs**
|
||||
- Properties:
|
||||
- `string DataSetDirectory { get; private set; }` - Path to the DTS file
|
||||
- `string TestId { get; private set; }` - Identifier of the modified test
|
||||
- Constructor: `TestModificationArgs(string dtsFilePath, string testId)`
|
||||
|
||||
**ShiftT0Event**
|
||||
- Signature: `public class ShiftT0Event : CompositePresentationEvent<ShiftT0EventArguments>`
|
||||
- Payload: `ShiftT0EventArguments`
|
||||
- Behavior: Published to shift the T0 marker position.
|
||||
|
||||
**ShiftT0EventArguments**
|
||||
- Properties:
|
||||
- `double T0Time { get; }` - The T0 time value
|
||||
- `bool IsInitialization { get; }` - Whether this shift is part of initialization
|
||||
- `int T0Steps { get; }` - Steps/samples from T0 to shift
|
||||
- `bool IsKeyPress { get; }` - Whether shift was caused by arrow key press
|
||||
- Constructors:
|
||||
- `ShiftT0EventArguments(double t0, bool isInitialization)` - Sets T0Time, defaults T0Steps=0, IsKeyPress=false
|
||||
- `ShiftT0EventArguments(int steps, bool isInitialization, bool isKeyPress)` - Sets T0Steps, defaults T0Time=0D
|
||||
|
||||
### Invariants
|
||||
- `TestModificationArgs.DataSetDirectory` and `TestId` are set only at construction and cannot be modified.
|
||||
- `ShiftT0EventArguments` properties are immutable after construction.
|
||||
- When using the time-based constructor for `ShiftT0EventArguments`, `T0Steps` is always 0 and `IsKeyPress` is always false.
|
||||
- When using the steps-based constructor for `ShiftT0EventArguments`, `T0Time` is always 0D.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on**: `Microsoft.Practices.Prism.Events` (legacy Prism event aggregation), `DTS.Common.Interface` (for `ITestModificationModel`)
|
||||
- **Depended on by**: Unclear from source alone; likely consumed by viewer components, DataPro, and any module that modifies test data.
|
||||
|
||||
### Gotchas
|
||||
- The XML comment for `TestModificationChangedEvent` states "The Data Folder changed event" which appears inconsistent with the class name and payload type (`ITestModificationModel`).
|
||||
- Several files use `// ReSharper disable CheckNamespace` suggesting namespace inconsistencies that were suppressed rather than fixed.
|
||||
- The `ShiftT0EventArguments` class has two mutually exclusive constructors; the time-based and steps-based approaches cannot be combined in a single instance.
|
||||
|
||||
---
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerChartOptions/ResetZoomChangedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerChartOptions/CursorShowChangedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerChartOptions/CursorsClearChangedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerChartOptions/CursorShowMinMaxChangedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerChartOptions/CursorsAlailableChangedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerChartOptions/SaveToPDFRequestedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerChartOptions/ChartAxisChangedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerChartOptions/ChartOptionsChangedEvent.cs
|
||||
generated_at: "2026-04-17T16:02:47.397446+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "e4db1ed01ee3ab20"
|
||||
---
|
||||
|
||||
# ViewerChartOptions
|
||||
|
||||
### Purpose
|
||||
This module defines Prism-based event classes for chart viewer operations, enabling loosely-coupled communication between components in the viewer subsystem. Events cover zoom reset, cursor display/clearing, PDF export, and axis/options changes. Uses the older `Microsoft.Practices.Prism.Events` namespace (Prism 4.x or earlier).
|
||||
|
||||
### Public Interface
|
||||
|
||||
**ResetZoomChangedEvent**
|
||||
- Inherits `CompositePresentationEvent<bool>` - Event payload is a boolean.
|
||||
|
||||
**CursorShowChangedEvent**
|
||||
- Inherits `CompositePresentationEvent<bool>` - Event payload is a boolean.
|
||||
|
||||
**CursorsClearChangedEvent**
|
||||
- Inherits `CompositePresentationEvent<bool>` - Event payload is a boolean.
|
||||
|
||||
**CursorShowMinMaxChangedEvent**
|
||||
- Inherits `CompositePresentationEvent<bool>` - Event payload is a boolean.
|
||||
|
||||
**CursorsAlailableChangedEvent**
|
||||
- Inherits `CompositePresentationEvent<bool>` - Event payload is a boolean. Note: typo in class name ("Alailable" vs "Available").
|
||||
|
||||
**SaveToPDFRequestedEvent**
|
||||
- Inherits `CompositePresentationEvent<string>` - Event payload is a string (likely file path).
|
||||
|
||||
**ChartAxisChangedEvent**
|
||||
- Inherits `CompositePresentationEvent<ChartAxisChangedEventArg>` - Event payload is `ChartAxisChangedEventArg`.
|
||||
|
||||
**ChartAxisChangedEventArg**
|
||||
- `IBaseViewModel ParentVM { get; set; }` - Parent view model reference.
|
||||
- `string Axis { get; set; }` - Axis identifier.
|
||||
- `double MinValue { get; set; }` - Minimum axis value.
|
||||
- `double MaxValue { get; set; }` - Maximum axis value.
|
||||
|
||||
**ChartOptionsChangedEvent**
|
||||
- Inherits `CompositePresentationEvent<ChartOptionsChangedEventArg>` - Event payload is `ChartOptionsChangedEventArg`.
|
||||
|
||||
**ChartOptionsChangedEventArg**
|
||||
- `IBaseViewModel ParentVM { get; set; }` - Parent view model reference.
|
||||
- `IChartOptionsModel Model { get; set; }` - Chart options model.
|
||||
- `string ChartType { get; set; }` - Chart type identifier.
|
||||
|
||||
### Invariants
|
||||
- All events inherit from `CompositePresentationEvent<T>` and are empty classes (no additional members).
|
||||
- Event args classes (`ChartAxisChangedEventArg`, `ChartOptionsChangedEventArg`) are mutable POCOs with public getters and setters.
|
||||
- The `
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerFilter/FilterParameterChangedEvent.cs
|
||||
generated_at: "2026-04-17T16:39:31.229290+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "e2918a5abc891c6f"
|
||||
---
|
||||
|
||||
# Documentation: FilterParameterChangedEvent
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module provides a Prism Event Aggregator event for broadcasting filter parameter changes within a viewer context. It enables loosely coupled communication between view models when filter criteria are modified, allowing components to react to filter changes without direct references to the source. The event carries information about both the requesting view model and the filter parameter value.
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `FilterParameterArgs`
|
||||
|
||||
A payload class that carries data for filter parameter change notifications.
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `Requester` | `IBaseViewModel` | The view model that requested the filter operation. Has public getter and setter. |
|
||||
| `Param` | `string` | The filter parameter value. Has public getter and setter. |
|
||||
|
||||
### `FilterParameterChangedEvent`
|
||||
|
||||
An event class for publishing/subscribing to filter parameter changes.
|
||||
|
||||
```
|
||||
public class FilterParameterChangedEvent : CompositePresentationEvent<FilterParameterArgs>
|
||||
```
|
||||
|
||||
Inherits from `CompositePresentationEvent<FilterParameterArgs>`, providing standard Prism event aggregation capabilities (publish, subscribe, unsubscribe).
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- The `FilterParameterChangedEvent` always publishes payloads of type `FilterParameterArgs`.
|
||||
- Both `Requester` and `Param` properties are nullable (no validation is enforced at the type level).
|
||||
- The class uses a default parameterless constructor (implicitly defined).
|
||||
- The event follows the Prism Event Aggregator pattern and requires an `IEventAggregator` instance to function properly.
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
### This module depends on:
|
||||
- **`DTS.Common.Base`** - Provides `IBaseViewModel` interface used for the `Requester` property.
|
||||
- **`Microsoft.Practices.Prism.Events`** - Provides `CompositePresentationEvent<T>` base class for event definition.
|
||||
|
||||
### What depends on this module:
|
||||
- **Unknown from source alone** - No consumers are defined in this file. Typically, view models that publish or subscribe to filter changes would depend on this event.
|
||||
|
||||
## 5. Gotchas
|
||||
|
||||
- **Namespace mismatch**: The file is located at `Common/DTS.CommonCore/Events/DTS.Viewer/ViewerFilter/` but the declared namespace is `DTS.Common.Events`. The `// ReSharper disable CheckNamespace` directive suppresses the IDE warning, suggesting this is intentional but may cause confusion when locating the file.
|
||||
- **Mutable payload**: `FilterParameterArgs` properties have public setters, allowing modification after event publication. Subscribers could potentially mutate the payload, affecting other subscribers.
|
||||
- **No null
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerSettings/CalibrationBehaviorSettableInViewerChangedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerSettings/ViewerSettingsVisibilityChangedEvent.cs
|
||||
generated_at: "2026-04-17T16:37:21.633818+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "cb19af85b80535a7"
|
||||
---
|
||||
|
||||
# Documentation: Viewer Settings Events
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines two Prism event classes used for communication within a viewer subsystem. These events facilitate decoupled publish/subscribe messaging regarding viewer settings state changes—specifically, whether calibration behavior can be set in the viewer, and the visibility state of viewer settings UI. Both events inherit from `CompositePresentationEvent<T>` and serve as typed message carriers in an event aggregation pattern.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `CalibrationBehaviorSettableInViewerChangedEvent`
|
||||
- **Signature:** `public class CalibrationBehaviorSettableInViewerChangedEvent : CompositePresentationEvent<bool>`
|
||||
- **Behavior:** A typed event that carries a `bool` payload indicating whether calibration behavior is settable in the viewer. Subscribers receive `true` or `false` to denote the current settable state. No additional members are defined beyond the inherited `CompositePresentationEvent<bool>`.
|
||||
|
||||
### `ViewerSettingsVisibilityChangedEvent`
|
||||
- **Signature:** `public class ViewerSettingsVisibilityChangedEvent : CompositePresentationEvent<Visibility>`
|
||||
- **Behavior:** A typed event that carries a `System.Windows.Visibility` payload (e.g., `Visible`, `Hidden`, `Collapsed`). Subscribers receive visibility state changes for the viewer settings UI. No additional members are defined beyond the inherited `CompositePresentationEvent<Visibility>`.
|
||||
|
||||
---
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- Both event classes are sealed by implication of having no `virtual` or `abstract` members; they are intended for instantiation and use as-is.
|
||||
- The payload type for `CalibrationBehaviorSettableInViewerChangedEvent` is always `bool`; no other type may be published through this event.
|
||||
- The payload type for `ViewerSettingsVisibilityChangedEvent` is always `System.Windows.Visibility`; no other type may be published through this event.
|
||||
- Both classes reside in the `DTS.Common.Events` namespace regardless of their file location (see Gotchas).
|
||||
|
||||
---
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
### This module depends on:
|
||||
- `Microsoft.Practices.Prism.Events.CompositePresentationEvent<T>` — base class for both events, providing publish/subscribe infrastructure.
|
||||
- `System.Windows.Visibility` — enum type used as payload for `ViewerSettingsVisibilityChangedEvent`.
|
||||
|
||||
### What depends on this module:
|
||||
- **Inferred consumers:** Any component that publishes or subscribes to viewer settings state changes, likely within a viewer module or related UI components. Specific consumers cannot be determined from these source files alone.
|
||||
|
||||
---
|
||||
|
||||
## 5. Gotchas
|
||||
|
||||
- **Namespace/file location mismatch:** Both files contain `// ReSharper disable CheckNamespace` and are located in a subdirectory path (`DTS.Viewer/ViewerSettings/`), yet declare namespace `DTS.Common.Events`. This suggests intentional namespace flattening for event aggregation purposes, but may cause confusion when navigating the codebase.
|
||||
- **No explicit constructors or members:** Both classes rely entirely on inherited functionality from `CompositePresentationEvent<T>`. Developers unfamiliar with Prism's event aggregation pattern may need to reference Prism documentation to understand usage (Subscribe, Publish, etc.).
|
||||
- **WPF dependency:** `ViewerSettingsVisibilityChangedEvent` uses `System.Windows.Visibility`, tying it to WPF/UI concerns. This may limit reusability in non-WPF contexts.
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/ChannelSelectionCountNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/ChannelsModificationNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/ChannelSelectionChangeNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/GraphChannelReadCalcProgressChangedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/GraphChannelsReadCompletedNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/DataFileSelectedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/GraphLoadedCountNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/TestLoadedCountNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/TestSummaryCountNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/GraphClearNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/GraphSelectedChannelCountNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/GraphSelectedChannelsNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/ChannelsModificationLineFitNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/TestSummaryChangeNotification.cs
|
||||
- Common/DTS.CommonCore/Events/DTS.Viewer/ViewerTestSummary/DataFolderChangedEvent.cs
|
||||
generated_at: "2026-04-17T15:29:01.513697+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "fc5a35e0bc4c988a"
|
||||
---
|
||||
|
||||
# Documentation: DTS.Common.Events (ViewerTestSummary)
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines a set of Prism-based pub/sub events for coordinating state changes within the Viewer Test Summary subsystem. These events facilitate loose coupling between components by enabling notification of channel selections, graph loading/progress, test summary changes, and data file/folder selections. The events follow the `CompositePresentationEvent<T>` pattern from Microsoft.Practices.Prism, allowing subscribers to receive strongly-typed payloads when specific UI or data operations occur.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### Channel Selection Events
|
||||
|
||||
#### `ChannelSelectionCountNotification`
|
||||
- **Signature:** `public class ChannelSelectionCountNotification : CompositePresentationEvent<int>`
|
||||
- **Behavior:** Publishes the count of selected channels as an integer value.
|
||||
|
||||
#### `ChannelSelectionChangeNotification`
|
||||
- **Signature:** `public class ChannelSelectionChangeNotification : CompositePresentationEvent<List<ITestChannel>>`
|
||||
- **Behavior:** Publishes a list of `ITestChannel` objects when the selected Test Summary list changes.
|
||||
|
||||
#### `ChannelsModificationNotification`
|
||||
- **Signature:** `public class ChannelsModificationNotification : CompositePresentationEvent<List<ITestChannel>>`
|
||||
- **Behavior:** Publishes a list of `ITestChannel` objects when the number of selected graphs changes.
|
||||
|
||||
#### `ChannelsModificationLineFitNotification`
|
||||
- **Signature:** `public class ChannelsModificationLineFitNotification : CompositePresentationEvent<LineFitArgs>`
|
||||
- **Behavior:** Publishes line fit modification data with channel and index range information.
|
||||
|
||||
**Payload class `LineFitArgs`:**
|
||||
```csharp
|
||||
public LineFitArgs(ITestChannel channel, ulong startIndex, ulong endIndex)
|
||||
```
|
||||
- `Channel` (ITestChannel): The test channel being modified
|
||||
- `StartIndex` (ulong): Starting index for the line fit
|
||||
- `EndIndex` (ulong): Ending index for
|
||||
Reference in New Issue
Block a user