91 lines
3.8 KiB
Markdown
91 lines
3.8 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableShuntDeflectionAttribute.cs
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableFilterFrequencyAttribute.cs
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableIsoCodeAttribute.cs
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableDescriptionAttribute.cs
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableSerialNumberAttribute.cs
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableUnitsAttribute.cs
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableMinMaxEuAttribute.cs
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableCfcAttribute.cs
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableTargetShuntDeflectionAttribute.cs
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableMeasuredShuntDeflectionAttribute.cs
|
||
|
|
- Common/DTS.Common.SerializationPlus/Control/Event/Module/AnalogInputChannel/ReviewableShuntDeflectionPercentageAttribute.cs
|
||
|
|
generated_at: "2026-04-17T15:31:05.691210+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "4f8edc6331324b2a"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: AnalogInputChannel Reviewable Attributes
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module provides a collection of reviewable attribute classes nested within `DTS.Slice.Control.Event.Module.AnalogInputChannel`. These classes serve as adapters that extract, format, and present channel-specific metadata—such as calibration values, filter settings, engineering units, and measurement errors—for display or reporting purposes. Each attribute inherits from `Slice.Control.Event.Module.Channel.ReviewableAttribute` and uses a delegate-based approach to lazily retrieve values from the underlying channel object.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
All classes are nested within the partial class hierarchy: `Event.Module.AnalogInputChannel`.
|
||
|
|
|
||
|
|
### ReviewableShuntDeflectionAttribute
|
||
|
|
```csharp
|
||
|
|
public ReviewableShuntDeflectionAttribute(Event.Module.Channel channel)
|
||
|
|
```
|
||
|
|
- **Label:** "Shunt Deflection (mV)"
|
||
|
|
- **Behavior:** Returns `MeasuredShuntDeflectionMv` from `IShuntAware` interface, formatted to 1 decimal place.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### ReviewableFilterFrequencyAttribute
|
||
|
|
```csharp
|
||
|
|
public ReviewableFilterFrequencyAttribute(Event.Module.Channel channel)
|
||
|
|
```
|
||
|
|
- **Label:** "Filter Frequency"
|
||
|
|
- **Behavior:** Returns `CutoffFrequencyHz` from `SaeJ211Filter`, cast to integer and formatted with thousands separator ("N").
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### ReviewableIsoCodeAttribute
|
||
|
|
```csharp
|
||
|
|
public ReviewableIsoCodeAttribute(Event.Module.Channel channel)
|
||
|
|
```
|
||
|
|
- **Label:** "ISO Code"
|
||
|
|
- **Behavior:** Returns `IsoCode` from `AnalogInputChannel` as string.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### ReviewableDescriptionAttribute
|
||
|
|
```csharp
|
||
|
|
public ReviewableDescriptionAttribute(Event.Module.Channel channel)
|
||
|
|
```
|
||
|
|
- **Label:** "Description"
|
||
|
|
- **Behavior:** Returns `ChannelDescriptionString` from the channel.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### ReviewableSerialNumberAttribute
|
||
|
|
```csharp
|
||
|
|
public ReviewableSerialNumberAttribute(Event.Module.Channel channel)
|
||
|
|
```
|
||
|
|
- **Label:** "Serial Number"
|
||
|
|
- **Behavior:** Returns `SerialNumber` from `AnalogInputChannel` as string.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### ReviewableUnitsAttribute
|
||
|
|
```csharp
|
||
|
|
public ReviewableUnitsAttribute(Event.Module.Channel channel)
|
||
|
|
```
|
||
|
|
- **Label:** "Units"
|
||
|
|
- **Behavior:** Returns `EngineeringUnits` from `IEngineeringUnitAware` interface as string.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### ReviewableMinMaxEuAttribute
|
||
|
|
```csharp
|
||
|
|
public ReviewableMinMaxEuAttribute(Event.Module.Channel channel)
|
||
|
|
```
|
||
|
|
- **Label:** "Max/Min (EU)"
|
||
|
|
- **Behavior:** Returns a combined string of `DataMaxFilteredEu` and `DataMinFilteredEu`, both formatted to
|