67 lines
2.8 KiB
Markdown
67 lines
2.8 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common/Events/Sensors/CalibrationBehaviorSettingChangedEvent.cs
|
||
|
|
- Common/DTS.Common/Events/Sensors/ExportCalibrationBehaviorSettingChangedEvent.cs
|
||
|
|
- Common/DTS.Common/Events/Sensors/SensorFilterTypeChangedEvent.cs
|
||
|
|
generated_at: "2026-04-17T16:35:56.568628+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "8318e849b47a0f7f"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: DTS.Common.Events.Sensors
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines event types for the Prism pub/sub event system, specifically for sensor-related state changes. It provides three event classes that enable loosely-coupled communication between components: two for calibration behavior setting changes (`CalibrationBehaviorSettingChangedEvent` and `ExportCalibrationBehaviorSettingChangedEvent`), and one for sensor filter type changes (`SensorFilterTypeChangedEvent`). These events facilitate notification when sensor calibration behaviors or filter configurations are modified, allowing subscribers to react without direct coupling to the event publishers.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### `CalibrationBehaviorSettingChangedEvent`
|
||
|
|
**Signature:**
|
||
|
|
```csharp
|
||
|
|
public class CalibrationBehaviorSettingChangedEvent : PubSubEvent<DTS.Common.Enums.Sensors.CalibrationBehaviors>
|
||
|
|
```
|
||
|
|
A pub/sub event that carries a `CalibrationBehaviors` enum value as its payload. Used to notify subscribers when a calibration behavior setting has changed.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `ExportCalibrationBehaviorSettingChangedEvent`
|
||
|
|
**Signature:**
|
||
|
|
```csharp
|
||
|
|
public class ExportCalibrationBehaviorSettingChangedEvent : PubSubEvent<DTS.Common.Enums.Sensors.CalibrationBehaviors>
|
||
|
|
```
|
||
|
|
A pub/sub event that carries a `CalibrationBehaviors` enum value as its payload. Used to notify subscribers when an export-related calibration behavior setting has changed. Distinct from `CalibrationBehaviorSettingChangedEvent` to allow separate subscription channels.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `SensorFilterTypeChangedEvent`
|
||
|
|
**Signature:**
|
||
|
|
```csharp
|
||
|
|
public class SensorFilterTypeChangedEvent : PubSubEvent<SensorFilterTypeChangedEventArgs>
|
||
|
|
```
|
||
|
|
A pub/sub event that carries `SensorFilterTypeChangedEventArgs` as its payload. Used to notify subscribers that a sensor filter or ISO code filter field has changed.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `SensorFilterTypeChangedEventArgs`
|
||
|
|
**Signature:**
|
||
|
|
```csharp
|
||
|
|
public class SensorFilterTypeChangedEventArgs
|
||
|
|
```
|
||
|
|
|
||
|
|
**Properties:**
|
||
|
|
| Property | Type | Access |
|
||
|
|
|----------|------|--------|
|
||
|
|
| `ISOCodeChar` | `char` | `public get; private set` |
|
||
|
|
| `EventType` | `EventTypes` | `public get; private set` |
|
||
|
|
| `FilterClass` | `FilterClassType` | `public get; private set` |
|
||
|
|
| `Calibration` | `ISensorCalibration` | `public get; private set` |
|
||
|
|
| `Sensor` | `ISensorData` | `public get; private set` |
|
||
|
|
| `UseISOCodeFilterMapping` | `bool` | `public get; private set` |
|
||
|
|
| `UseZeroForUnfiltered` | `bool` | `public get; private set` |
|
||
|
|
|
||
|
|
**Nested Enum:**
|
||
|
|
```csharp
|