Files
DP44/docs/ai/Common/DTS.Common/Events/Hardware/HardwareList.md

51 lines
3.1 KiB
Markdown
Raw Normal View History

2026-04-17 14:55:32 -04:00
---
source_files:
- Common/DTS.Common/Events/Hardware/HardwareList/HardwareListShowCompactEvent.cs
- Common/DTS.Common/Events/Hardware/HardwareList/HardwareListEditHardwareEvent.cs
- Common/DTS.Common/Events/Hardware/HardwareList/HardwareListHardwareSelectedEvent.cs
- Common/DTS.Common/Events/Hardware/HardwareList/HardwareReplaceEvent.cs
- Common/DTS.Common/Events/Hardware/HardwareList/HardwareSavedEvent.cs
- Common/DTS.Common/Events/Hardware/HardwareList/HardwareListHardwareIncludedEvent.cs
- Common/DTS.Common/Events/Hardware/HardwareList/HardwareListHardwareTestPTPDomainIDEvent.cs
- Common/DTS.Common/Events/Hardware/HardwareList/HardwareListHardwareTestSampleRateEvent.cs
- Common/DTS.Common/Events/Hardware/HardwareList/HardwareListHardwareTestClockMasterEvent.cs
- Common/DTS.Common/Events/Hardware/HardwareList/HardwareListHardwareTestAAFilterRateEvent.cs
generated_at: "2026-04-17T16:22:33.693123+00:00"
model: "zai-org/GLM-5-FP8"
schema_version: 1
sha256: "093b189fdc0d0e9b"
---
# HardwareList
### Purpose
This module defines a collection of event types for the Prism Event Aggregator used to communicate changes and actions related to hardware within a hardware list. It facilitates loosely coupled communication between components regarding hardware selection, configuration changes (sample rate, clock master, PTP domain), and lifecycle events (saving, replacing).
### Public Interface
**Events (all inherit from `Prism.Events.PubSubEvent`)**
* `HardwareListShowCompactEvent` : `PubSubEvent<bool>`
* Payload: `bool` indicating the compact/expanded state.
* Used to signal a change in the view mode (compact vs. expanded).
* `HardwareListEditHardwareEvent` : `PubSubEvent<string>`
* Payload: `string` (likely a hardware identifier).
* Used to indicate a specific piece of hardware was selected for editing.
* `HardwareListHardwareSelectedEvent` : `PubSubEvent<string[]>`
* Payload: `string[]` (array of identifiers).
* Used to indicate one or more hardware items were selected.
* `HardwareReplaceEvent` : `PubSubEvent<Tuple<IHardware, IHardware>>`
* Payload: `Tuple<IHardware, IHardware>` (Old hardware, New hardware).
* Used to request a hardware replacement operation.
* `HardwareSavedEvent` : `PubSubEvent<Tuple<int, string>>`
* Payload: `Tuple<int, string>` (Database ID, Serial Number).
* Used to indicate hardware was added or updated.
* `HardwareListHardwareIncludedEvent` : `PubSubEvent<HardwareListHardwareIncludedEventArgs>`
* Payload: `HardwareListHardwareIncludedEventArgs`.
* Used to signal a change in the "included" status of hardware.
* `HardwareListHardwareTestPTPDomainIDEvent` : `PubSubEvent<HardwareListHardwareTestPTPDomainIDEventArgs>`
* Payload: `HardwareListHardwareTestPTPDomainIDEventArgs`.
* Used to indicate a change in the PTP Domain ID for a test.
* `HardwareListHardwareTestSampleRateEvent` : `PubSubEvent<HardwareListHardwareTestSampleRateEventArgs>`
* Payload: `HardwareListHardwareTestSampleRateEventArgs`.
* Used to indicate a change in the sample rate for