init
This commit is contained in:
395
enriched-partialglm/Common/DTS.CommonCore/Enums.md
Normal file
395
enriched-partialglm/Common/DTS.CommonCore/Enums.md
Normal file
@@ -0,0 +1,395 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Enums/IsoRestrictionLevels.cs
|
||||
- Common/DTS.CommonCore/Enums/GPSSentenceTypes.cs
|
||||
- Common/DTS.CommonCore/Enums/UartDataFormat.cs
|
||||
- Common/DTS.CommonCore/Enums/NetworkSelection.cs
|
||||
- Common/DTS.CommonCore/Enums/ScriptTypes.cs
|
||||
- Common/DTS.CommonCore/Enums/InitializationTypes.cs
|
||||
- Common/DTS.CommonCore/Enums/Strings.cs
|
||||
- Common/DTS.CommonCore/Enums/MigrationResult.cs
|
||||
- Common/DTS.CommonCore/Enums/SLICE6MulticastProperties.cs
|
||||
- Common/DTS.CommonCore/Enums/RibbonTabNames.cs
|
||||
- Common/DTS.CommonCore/Enums/IsoSupportLevels.cs
|
||||
- Common/DTS.CommonCore/Enums/ImportFormats.cs
|
||||
- Common/DTS.CommonCore/Enums/TabControlOperation.cs
|
||||
- Common/DTS.CommonCore/Enums/IncludeOverwriteName.cs
|
||||
- Common/DTS.CommonCore/Enums/RibbonControlOperation.cs
|
||||
- Common/DTS.CommonCore/Enums/UICultures.cs
|
||||
- Common/DTS.CommonCore/Enums/T0Mode.cs
|
||||
- Common/DTS.CommonCore/Enums/VelocityUnit.cs
|
||||
- Common/DTS.CommonCore/Enums/ImportStatus.cs
|
||||
- Common/DTS.CommonCore/Enums/IsoViewMode.cs
|
||||
- Common/DTS.CommonCore/Enums/PopupWindowImage.cs
|
||||
- Common/DTS.CommonCore/Enums/UIItemStatus.cs
|
||||
- Common/DTS.CommonCore/Enums/DigitalOutputs.cs
|
||||
- Common/DTS.CommonCore/Enums/DigitalInputs.cs
|
||||
- Common/DTS.CommonCore/Enums/DataFlag.cs
|
||||
- Common/DTS.CommonCore/Enums/Squibs.cs
|
||||
- Common/DTS.CommonCore/Enums/SupportedExportFormatBitFlags.cs
|
||||
- Common/DTS.CommonCore/Enums/UartBaudRate.cs
|
||||
- Common/DTS.CommonCore/Enums/EnumBindingSourceExtension.cs
|
||||
- Common/DTS.CommonCore/Enums/UDPStreamProfile.cs
|
||||
- Common/DTS.CommonCore/Enums/ExcitationVoltageOptions.cs
|
||||
- Common/DTS.CommonCore/Enums/RecordingModes.cs
|
||||
- Common/DTS.CommonCore/Enums/ApplicationStatusTypes.cs
|
||||
- Common/DTS.CommonCore/Enums/ExportHeaderLine.cs
|
||||
- Common/DTS.CommonCore/Enums/StreamDigitalFilterTypes.cs
|
||||
- Common/DTS.CommonCore/Enums/CFCFilter.cs
|
||||
- Common/DTS.CommonCore/Enums/ClockSource.cs
|
||||
generated_at: "2026-04-16T12:00:02.414495+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "b809df2688f575c2"
|
||||
---
|
||||
|
||||
# Documentation: DTS.CommonCore.Enums
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines the canonical enumeration types and related utility classes for the DTS (Data Acquisition System) common core library. It provides strongly-typed constants for hardware configuration (UART, digital I/O, squibs, excitation voltages), data processing (CFC filters, recording modes, streaming profiles), application state management (status types, import/export formats), and UI concerns (cultures, popup images, ribbon controls). The enums serve as the shared vocabulary between hardware drivers, business logic, and presentation layers.
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### Enums
|
||||
|
||||
#### `GPSSentenceTypes`
|
||||
```csharp
|
||||
public enum GPSSentenceTypes { GPGGA, GPRMC }
|
||||
```
|
||||
Defines NMEA GPS sentence types for parsing GPS data streams.
|
||||
|
||||
#### `UartDataFormat`
|
||||
```csharp
|
||||
public enum UartDataFormat { Binary, PlainText, NMEA }
|
||||
```
|
||||
Specifies the data format for UART communication.
|
||||
|
||||
#### `NetworkSelection`
|
||||
```csharp
|
||||
public enum NetworkSelection { Default, NetworkId, NetworkDesc }
|
||||
```
|
||||
Defines network selection criteria.
|
||||
|
||||
#### `ScriptTypes`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum ScriptTypes { Migration, Initialization }
|
||||
```
|
||||
Categorizes script execution types.
|
||||
|
||||
#### `InitializationTypes`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum InitializationTypes { Aero, Crash, TSRAIR }
|
||||
```
|
||||
Defines initialization type categories.
|
||||
|
||||
#### `StringReplacementMode`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum StringReplacementMode { All, First, Last }
|
||||
```
|
||||
Controls string replacement behavior.
|
||||
|
||||
#### `MigrationResult`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum MigrationResult { OK, ExceptionThrown, WarningAllowStreamingModesWasNotMigrated }
|
||||
```
|
||||
Indicates the outcome of a migration operation.
|
||||
|
||||
#### `SLICE6Properties`
|
||||
```csharp
|
||||
public enum SLICE6Properties { SLICE6MulticastAddress, SLICE6MulticastCommandPort, SLICE6MulticastResponsePort }
|
||||
```
|
||||
Properties for SLICE6 UDP broadcast autodiscovery.
|
||||
|
||||
#### `IsoSupportLevels`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum IsoSupportLevels {
|
||||
[Description("ISO 13499")] ISO_ONLY,
|
||||
[Description("User specified channel codes")] TRANSITORY,
|
||||
[Description("No ISO")] NO_ISO
|
||||
}
|
||||
```
|
||||
Defines ISO 13499 channel code support levels.
|
||||
|
||||
#### `ImportFormats`
|
||||
```csharp
|
||||
public enum ImportFormats {
|
||||
NOT_SPECIFIED = 1, DTS_XML = 2, ISF = 3, TSF = 4, DTS_CSV = 5,
|
||||
TTS_XML = 6, CrashDesigner_XML = 7, E2X = 8, TTS_CSV = 9
|
||||
}
|
||||
```
|
||||
Specifies supported import file formats with explicit integer values.
|
||||
|
||||
#### `TabControlOperation` / `RibbonControlOperation`
|
||||
```csharp
|
||||
public enum TabControlOperation { AddedItem, RemovedItem }
|
||||
public enum RibbonControlOperation { AddedItem, RemovedItem }
|
||||
```
|
||||
Defines UI control modification operations.
|
||||
|
||||
#### `IncludeOverwriteName`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum IncludeOverwriteName { IncludedCheckBox, OverwriteCheckBox, ImportingTestSetupName }
|
||||
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum ExportChoices { ExportType, UnfilteredEUCheckBox, FilteredEUCheckBox, MVCheckBox, ADCCheckBox }
|
||||
```
|
||||
Import/export UI selection options.
|
||||
|
||||
#### `UICultures`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum UICultures {
|
||||
[DescriptionResource("UICultures_de-DE")] de_DE,
|
||||
[DescriptionResource("UICultures_en-US")] en_US,
|
||||
[DescriptionResource("UICultures_es-ES")] es_ES,
|
||||
[DescriptionResource("UICultures_fr-FR")] fr_FR,
|
||||
[DescriptionResource("UICultures_it-IT")] it_IT,
|
||||
[DescriptionResource("UICultures_ja-JP")] ja_JP
|
||||
}
|
||||
```
|
||||
Supported UI localization cultures.
|
||||
|
||||
#### `T0Mode`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum T0Mode {
|
||||
[Description("DAS")] DAS = 0,
|
||||
[Description("Test")] Test = 1
|
||||
}
|
||||
```
|
||||
Defines T0 (time zero) reference mode.
|
||||
|
||||
#### `VelocityUnit`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum VelocityUnit {
|
||||
[Description("EditTestSetupObjectMeta_VelocityUnit_KilometerPerHour")] KilometerPerHour = 0,
|
||||
[Description("EditTestSetupObjectMeta_VelocityUnit_MeterPerSecond")] MeterPerSecond = 1
|
||||
}
|
||||
```
|
||||
Velocity measurement units.
|
||||
|
||||
#### `ImportExtraStatus` / `PossibleStatus`
|
||||
```csharp
|
||||
public enum ImportExtraStatus { None, NormalizingIds, ReadingCalibrations, ReadingChannels, ReadingCustomerDetails, ReadingEngineerDetails, ReadingGroups, ReadingHardware, ReadingLabDetails, ReadingSensors, ReadingTestSetups, ReadingUsers, ReadingXML }
|
||||
public enum PossibleStatus { Waiting, Working, Done, Failed, Reading, Importing }
|
||||
```
|
||||
Import operation status indicators.
|
||||
|
||||
#### `IsoViewMode`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum IsoViewMode {
|
||||
[Description("ISOOnly")] ISOOnly,
|
||||
[Description("ISOAndUserCode")] ISOAndUserCode,
|
||||
[Description("UserCodeOnly")] UserCodeOnly,
|
||||
[Description("ChannelNameOnly")] ChannelNameOnly
|
||||
}
|
||||
```
|
||||
Channel display naming convention.
|
||||
|
||||
#### `PopupWindowImage`
|
||||
```csharp
|
||||
public enum PopupWindowImage { Warning = 0, Error = 1, Question = 2, Information = 3 }
|
||||
```
|
||||
Defines popup window icon types.
|
||||
|
||||
#### `UIItemStatus`
|
||||
```csharp
|
||||
public enum UIItemStatus { None, Success, Failed, Error, Warning }
|
||||
```
|
||||
UI item operation status.
|
||||
|
||||
#### `DigitalOutputModes`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum DigitalOutputModes {
|
||||
[Description("Off")] NONE = 0,
|
||||
[DescriptionResource("DigitalOutputMode_FVLH")] FVLH = 1 << 0,
|
||||
[DescriptionResource("DigitalOutputMode_FVHL")] FVHL = 1 << 1,
|
||||
[DescriptionResource("DigitalOutputMode_CCNO")] CCNO = 1 << 2,
|
||||
[DescriptionResource("DigitalOutputMode_CCNC")] CCNC = 1 << 3
|
||||
}
|
||||
```
|
||||
Digital output configuration modes (bitwise flags).
|
||||
|
||||
#### `DigitalInputModes`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum DigitalInputModes {
|
||||
NONE = 1 << 0,
|
||||
[DescriptionResource("DigitalInputMode_TLH")] TLH = 1 << 1,
|
||||
[DescriptionResource("DigitalInputMode_THL")] THL = 1 << 2,
|
||||
[DescriptionResource("DigitalInputMode_CCNO")] CCNO = 1 << 3,
|
||||
[DescriptionResource("DigitalInputMode_CCNC")] CCNC = 1 << 4
|
||||
}
|
||||
```
|
||||
Digital input configuration modes (bitwise flags).
|
||||
|
||||
#### `DataFlag`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum DataFlag {
|
||||
[Description("None")] None = 0,
|
||||
[Description("Normal")] Normal = 1,
|
||||
[Description("Saturated")] Saturated = 2,
|
||||
[Description("Zero Crossing Error")] ZeroCrossing = 3,
|
||||
[Description("Broken Wire")] BrokenWire = 4,
|
||||
[Description("Other")] Other = -1
|
||||
}
|
||||
```
|
||||
Data quality/status flags for channel data.
|
||||
|
||||
#### `SquibMeasurementType` / `SquibFireMode`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum SquibMeasurementType { NONE = 0, CURRENT = 1 << 0, INIT_SIGNAL = 1 << 1, VOLTAGE = 1 << 2 }
|
||||
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum SquibFireMode {
|
||||
NONE = 1 << 0,
|
||||
[DescriptionResource("SquibFireMode_Cap")] CAP = 1 << 1,
|
||||
[DescriptionResource("SquibFireMode_CC")] CONSTANT = 1 << 2,
|
||||
AC = 1 << 3
|
||||
}
|
||||
```
|
||||
Squib (explosive initiator) configuration modes.
|
||||
|
||||
#### `SupportedExportFormatBitFlags`
|
||||
```csharp
|
||||
[Flags]
|
||||
public enum SupportedExportFormatBitFlags {
|
||||
none = 0x0, csvunfiltered = 0x1, diademadc = 0x2, isounfiltered = 0x4,
|
||||
somatunfiltered = 0x8, tdmsadc = 0x10, toyotaunfiltered = 0x20, tsvunfiltered = 0x40,
|
||||
csvfiltered = 0x80, isofiltered = 0x200, somatfiltered = 0x400, tdasadc = 0x800,
|
||||
toyotafiltered = 0x1000, tsvfiltered = 0x2000, rdfadc = 0x4000, ChryslerDDAS = 0x8000,
|
||||
HDFUnfiltered = 0x10000, HDFFiltered = 0x20000, HDFMV = 0x40000, HDFADC = 0x80000,
|
||||
xlsxfiltered = 0x100000, xlsxunfiltered = 0x200000, CSVADC = 0x400000, CSVMV = 0x800000,
|
||||
Ch10FilteredEU = 0x1000000, Ch10UnfilteredEU = 0x2000000, FIATASC = 0x4000000
|
||||
}
|
||||
```
|
||||
Bitwise flags for supported export formats.
|
||||
|
||||
#### `UartBaudRate`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum UartBaudRate : uint {
|
||||
_110 = 110, _300 = 300, _600 = 600, _1200 = 1200, _2400 = 2400,
|
||||
_4800 = 4800, _9600 = 9600, _14400 = 14400, _19200 = 19200, _38400 = 38400,
|
||||
_57600 = 57600, _115200 = 115200, _230400 = 230400, _460800 = 460800, _921600 = 921600
|
||||
}
|
||||
```
|
||||
Standard UART baud rates; enum name prefixed with underscore, value equals actual baud rate.
|
||||
|
||||
#### `UDPStreamProfile`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum UDPStreamProfile : byte {
|
||||
RTCStreaming = 0, DTS_UDP = 1, CH10_MANUAL_CONFIG = 2, CH10_PCM128_MM = 3,
|
||||
CH10_ANALOG = 4, CH10_PCM_STANDARD = 5, CH10_PCM_SUPERCOM = 6,
|
||||
CH10_PCM_128BIT_2HDR = 7, CH10_ANALOG_2HDR = 8, CH10_PCM_STANDARD_2HDR = 9,
|
||||
CH10_PCM_SUPERCOM_2HDR = 10, TMNS_PCM_STANDARD = 11, TMNS_PCM_SUPERCOM = 12,
|
||||
IENA_PTYPE_STREAM = 13, UART_STREAM = 14
|
||||
}
|
||||
```
|
||||
UDP streaming profiles for data transmission (Chapter 10, TmNS, IENA formats).
|
||||
|
||||
#### `ExcitationVoltageOptions.ExcitationVoltageOption`
|
||||
```csharp
|
||||
public enum ExcitationVoltageOption {
|
||||
[VoltageMagnitude(0.0)][Description("Undefined")] Undefined = 1,
|
||||
[VoltageMagnitude(2.0)][Description("2.0")] Volt2 = 2,
|
||||
[VoltageMagnitude(2.5)][Description("2.5")] Volt2_5 = 4,
|
||||
[VoltageMagnitude(3.0)][Description("3.0")] Volt3 = 8,
|
||||
[VoltageMagnitude(5.0)][Description("5.0")] Volt5 = 16,
|
||||
[VoltageMagnitude(10.0)][Description("10.0")] Volt10 = 32,
|
||||
[VoltageMagnitude(1.0)][Description("1.0")] Volt1 = 64
|
||||
}
|
||||
```
|
||||
Sensor excitation voltage options with custom `VoltageMagnitudeAttribute` for extracting numerical values.
|
||||
|
||||
#### `RecordingModes`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum RecordingModes {
|
||||
CircularBuffer, Recorder, HybridRecorder, S6A_DeviceStreamingOnly,
|
||||
CircularBufferPlusUART, RecorderPlusUART, MultipleEventCircularBuffer,
|
||||
MultipleEventRecorder, ContinuousRecorder, RecorderAndStreamSubSample,
|
||||
CircularBufferAndStreamSubSample, Active, MultipleEventActive,
|
||||
MultipleEventHybridRecorder, Streaming, Scheduled, Interval,
|
||||
MultipleEventCircularBufferPlusUART, MultipleEventRecorderPlusUART,
|
||||
ContinuousRecorderPlusUART, RAMActive, MultipleEventRAMActive,
|
||||
RecordOnBoot, RecordOnBootPlusUART, MultipleEventHybridAndStream,
|
||||
HybridAndStream, MultipleEventCircularBufferAndStream,
|
||||
MultipleEventRecorderAndStream
|
||||
}
|
||||
```
|
||||
DAS recording mode configurations.
|
||||
|
||||
#### `ApplicationStatusTypes`
|
||||
```csharp
|
||||
public enum ApplicationStatusTypes {
|
||||
IDLE, SettingConfiguration, ClearingFlash, Arm, AutoArmPrepare,
|
||||
WaitingForStart, WaitingForTrigger, WaitingForStartWithEvent,
|
||||
WaitingForTriggerCheck, WaitingForAutoArm, WaitingForStreaming,
|
||||
Passed, FailedStart, FailedTrigger, Done, FailedArm, FailedDisarm,
|
||||
// ... (70+ total status values)
|
||||
}
|
||||
```
|
||||
Comprehensive application state machine status values.
|
||||
|
||||
#### `FtssHeaderLine` / `XLSXExportHeaderLine`
|
||||
```csharp
|
||||
public enum FtssHeaderLine {
|
||||
[Description("Headers")] Headers = 0,
|
||||
[Description("Test Date")] TestDate,
|
||||
// ... (30+ header line types)
|
||||
}
|
||||
```
|
||||
Defines header line content for CSV and XLSX file exports.
|
||||
|
||||
#### `StreamDigitalFilterTypes`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum StreamDigitalFilterTypes {
|
||||
NO_DSP_FILTER = 0,
|
||||
CH10_IIR_6TH_OPTION_80X = 5,
|
||||
CH10_FIR_45T65T_OPTION_80X = 6,
|
||||
ALL_RT_IIR_6TH_OPTION_80X = 13,
|
||||
ALL_RT_FIR_45T65T_OPTION_80X = 14
|
||||
}
|
||||
```
|
||||
DSP IIR/FIR filter profiles for streaming data.
|
||||
|
||||
#### `CFCFilter`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum CFCFilter {
|
||||
[Description("None")] None = 0,
|
||||
[Description("Unfiltered")] Unfiltered = -2,
|
||||
[Description("CFC 10")] Class10 = 17,
|
||||
[Description("CFC 60")] Class60 = 100,
|
||||
[Description("CFC 180")] Class180 = 300,
|
||||
[Description("CFC 600")] Class600 = 1000,
|
||||
[Description("CFC 1000")] Class1000 = 1650
|
||||
}
|
||||
```
|
||||
SAE CFC (Channel Frequency Class) filter definitions per ISO 6487.
|
||||
|
||||
#### `ClockSyncProfile` / `InputClockSource` / `OutputClockSource`
|
||||
```csharp
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum ClockSyncProfile : byte { None = 0, Manual, Slave_E2E, Master_E2E, Auto_E2E, /* 30+ profiles */ }
|
||||
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum InputClockSource : byte { None = 0, PTP = 1 << 0, IRIG = 1 << 1, GPS = 1 << 2, OnePPS = 1 << 3, /* combinations */ }
|
||||
|
||||
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
|
||||
public enum OutputClockSource : byte { None = 0, PTP =
|
||||
Reference in New Issue
Block a user