Files
DP44/docs/ai/Common/DTS.Common/Enums.md

457 lines
15 KiB
Markdown
Raw Normal View History

2026-04-17 14:55:32 -04:00
---
source_files:
- Common/DTS.Common/Enums/IsoRestrictionLevels.cs
- Common/DTS.Common/Enums/GPSSentenceTypes.cs
- Common/DTS.Common/Enums/UartDataFormat.cs
- Common/DTS.Common/Enums/NetworkSelection.cs
- Common/DTS.Common/Enums/ScriptTypes.cs
- Common/DTS.Common/Enums/DestructiveTestChoices.cs
- Common/DTS.Common/Enums/InitializationTypes.cs
- Common/DTS.Common/Enums/Strings.cs
- Common/DTS.Common/Enums/MigrationResult.cs
- Common/DTS.Common/Enums/SLICE6MulticastProperties.cs
- Common/DTS.Common/Enums/RibbonTabNames.cs
- Common/DTS.Common/Enums/IsoSupportLevels.cs
- Common/DTS.Common/Enums/TabControlOperation.cs
- Common/DTS.Common/Enums/IncludeOverwriteName.cs
- Common/DTS.Common/Enums/RibbonControlOperation.cs
- Common/DTS.Common/Enums/LogLevels.cs
- Common/DTS.Common/Enums/ImportFormats.cs
- Common/DTS.Common/Enums/UICultures.cs
- Common/DTS.Common/Enums/T0Mode.cs
- Common/DTS.Common/Enums/VelocityUnit.cs
- Common/DTS.Common/Enums/ImportStatus.cs
- Common/DTS.Common/Enums/IsoViewMode.cs
- Common/DTS.Common/Enums/PopupWindowImage.cs
- Common/DTS.Common/Enums/CanArbBaseBitrate.cs
- Common/DTS.Common/Enums/UIItemStatus.cs
- Common/DTS.Common/Enums/DigitalOutputs.cs
- Common/DTS.Common/Enums/DigitalInputs.cs
- Common/DTS.Common/Enums/DataFlag.cs
- Common/DTS.Common/Enums/Squibs.cs
- Common/DTS.Common/Enums/SupportedExportFormatBitFlags.cs
- Common/DTS.Common/Enums/UartBaudRate.cs
- Common/DTS.Common/Enums/EnumBindingSourceExtension.cs
- Common/DTS.Common/Enums/UDPStreamProfile.cs
- Common/DTS.Common/Enums/ExcitationVoltageOptions.cs
- Common/DTS.Common/Enums/ApplicationStatusTypes.cs
- Common/DTS.Common/Enums/ExportHeaderLine.cs
- Common/DTS.Common/Enums/RecordingModes.cs
- Common/DTS.Common/Enums/CFCFilter.cs
- Common/DTS.Common/Enums/ClockSource.cs
generated_at: "2026-04-17T15:26:42.516779+00:00"
model: "zai-org/GLM-5-FP8"
schema_version: 1
sha256: "db4cd84d7cef4480"
---
# DTS.Common.Enums Module Documentation
## 1. Purpose
This module defines enumerations, constants, and supporting utility classes used throughout the DTS (Data Acquisition System) codebase. It provides standardized domain-specific types for hardware configuration (baud rates, clock sources, recording modes), data processing (CFC filters, data flags), import/export operations (file formats, header definitions), application state management (status types, log levels), and UI concerns (cultures, popup images, ribbon controls). The enums serve as the canonical type definitions for cross-module communication and data serialization.
---
## 2. Public Interface
### Enumerations
#### `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 format of UART data streams.
#### `NetworkSelection`
```csharp
public enum NetworkSelection { Default, NetworkId, NetworkDesc }
```
Defines criteria for network selection operations.
#### `ScriptTypes`
```csharp
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
public enum ScriptTypes { Migration, Initialization }
```
Categorizes script execution types. Uses `EnumDescriptionTypeConverter` for UI display.
#### `DestructiveTestChoices`
```csharp
public enum DestructiveTestChoices { Yes, No, NotSet }
```
Tri-state selection for destructive test confirmation (FB 44625). `NotSet` indicates no selection made.
#### `InitializationTypes`
```csharp
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
public enum InitializationTypes { Aero, Crash, TSRAIR }
```
Defines initialization configuration types for different test scenarios.
#### `StringReplacementMode`
```csharp
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
public enum StringReplacementMode { All, First, Last }
```
Controls string replacement behavior in text processing operations.
#### `MigrationResult`
```csharp
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
public enum MigrationResult { OK, ExceptionThrown, WarningAllowStreamingModesWasNotMigrated }
```
Indicates outcome of data migration operations.
#### `SLICE6Properties`
```csharp
public enum SLICE6Properties { SLICE6MulticastAddress, SLICE6MulticastCommandPort, SLICE6MulticastResponsePort }
```
Property identifiers for SLICE6 UDP broadcast autodiscovery configuration.
#### `RibbonTabNames`
```csharp
public static class RibbonTabNames
{
public const string Tab1 = "TBD";
public const string Tab2 = "TBD";
public const string Tab3 = "TBD";
}
```
Placeholder constants for ribbon tab identifiers. All values are currently "TBD".
#### `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 compliance levels for channel coding.
#### `TabControlOperation` / `RibbonControlOperation`
```csharp
public enum TabControlOperation { AddedItem, RemovedItem }
public enum RibbonControlOperation { AddedItem, RemovedItem }
```
Identical enums representing 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 }
```
Defines checkbox/control identifiers for import/export UI operations.
#### `LogLevels`
```csharp
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
public enum LogLevels
{
[Description("LogLevel_Trace")] TRACE = 1,
[Description("LogLevel_Debug")] DEBUG = 2,
[Description("LogLevel_Info")] INFO = 3,
[Description("LogLevel_Warn")] WARN = 4,
[Description("LogLevel_Error")] ERROR = 5,
[Description("LogLevel_Critical")] CRITICAL = 6
}
```
Severity levels for logging, with explicit integer values 1-6.
#### `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
}
public enum ImportFileFormat { NoTestSetup, SingleTestSetup, MultipleTestSetup }
```
File format identifiers for import operations. `ImportFileFormat` categorizes files by test setup count (FB 40758).
#### `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. Uses `DescriptionResource` attribute for localization lookup.
#### `T0Mode`
```csharp
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
public enum T0Mode { [Description("DAS")] DAS = 0, [Description("Test")] Test = 1 }
```
Defines T0 (time zero) reference mode for data acquisition.
#### `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 }
```
Granular status tracking for import operations.
#### `IsoViewMode`
```csharp
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
public enum IsoViewMode
{
[Description("ISOOnly")] ISOOnly,
[Description("ISOAndUserCode")] ISOAndUserCode,
[Description("UserCodeOnly")] UserCodeOnly,
[Description("ChannelNameOnly")] ChannelNameOnly
}
```
Channel display mode for ISO-compliant views.
#### `IsoViewModeStatic`
```csharp
public abstract class IsoViewModeStatic
{
public static IsoViewMode ViewMode { get; set; }
}
```
Static holder for cross-module ISO view mode sharing. Does not persist or retrieve from database.
#### `PopupWindowImage`
```csharp
public enum PopupWindowImage { Warning = 0, Error = 1, Question = 2, Information = 3 }
```
Icon types for popup dialogs.
#### `CanArbBaseBitrate`
```csharp
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
public enum CanArbBaseBitrate
{
_50000 = 50000, _62000 = 62000, _83000 = 83000, _100000 = 100000,
_125000 = 125000, _250000 = 250000, _500000 = 500000, _1000000 = 1000000
}
```
CAN bus arbitration base bitrates. Enum member names prefixed with underscore to allow numeric identifiers.
#### `UIItemStatus`
```csharp
public enum UIItemStatus { None, Success, Failed, Error, Warning }
```
Status indicators for UI elements.
#### `SelectedItemsStatus`
```csharp
public abstract class SelectedItemsStatus
{
public static void SetUpdating(object o, bool updating);
public static bool GetUpdating(object o);
}
```
Thread-safe dictionary-based tracking of update states per object instance.
#### `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
}
```
Bitwise flags for digital output configuration (5V transitions and contact closure modes).
#### `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
}
```
Bitwise flags for digital input configuration (transitions and contact closure).
#### `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 flags for channel samples. `Other` uses value -1.
#### `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
}
```
Bitwise flags for squib (explosive initiator) configuration.
#### `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 export format capabilities.
#### `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. Underlying type is `uint`.
#### `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 configuration profiles (FB15313). Underlying type is `byte`.
#### `ExcitationVoltageOptions`
```csharp
public class ExcitationVoltageOptions
{
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
}
[AttributeUsage(AttributeTargets.Field)]
public class VoltageMagnitudeAttribute : Attribute
{
public double Value { get; }
public VoltageMagnitudeAttribute(double value);
}
public class VoltageMagnitudeAttributeCoder : AttributeCoder<ExcitationVoltageOption, VoltageMagnitudeAttribute, double>
{
public VoltageMagnitudeAttributeCoder();
}
}
```
Nested type providing excitation voltage options with magnitude extraction via custom attribute.
#### `ApplicationStatusTypes`
```csharp
public enum ApplicationStatusTypes
{
IDLE, SettingConfiguration, ClearingFlash, Arm, AutoArmPrepare, WaitingForStart,
WaitingForTrigger, WaitingForStartWithEvent, WaitingForTriggerCheck, WaitingForAutoArm,
WaitingForStreaming, Passed, FailedStart, FailedTrigger, Done, FailedArm, FailedDisarm,
// ... (50+ additional values)
}
```
Comprehensive application state machine values for DAS operations.
#### `FtssHeaderLine` / `UartHeaders` / `XLSXExportHeaderLine`
```csharp
public enum FtssHeaderLine { [Description("Headers")] Headers = 0, [Description("Test Date")] TestDate, ... }
public enum UartHeaders { [Description("Latitude")] Latitude, [Description("Longitude")] Longitude, ... }
public enum XLSXExportHeaderLine { [Description("Headers")] Headers = 0, [Description("Test Date")] TestDate, ... }
```
Header line definitions for CSV and XLSX export formats.
#### `HeaderLineExtension`
```csharp
public static class HeaderLineExtension
{
public static string GetDescription(this Enum genericEnum);
}
```
Extension method to retrieve `DescriptionAttribute` values from enum members.
#### `RecordingModes`
```csharp
[TypeConverter(typeof(EnumDescriptionTypeConverter))]
public enum RecordingModes
{
[Description("RecordingModes_CircularBuffer")][ProgrammableTr