119 lines
7.2 KiB
Markdown
119 lines
7.2 KiB
Markdown
---
|
|
source_files:
|
|
- Common/DTS.CommonCore/Strings/Strings.Designer.cs
|
|
generated_at: "2026-04-16T11:57:17.552440+00:00"
|
|
model: "zai-org/GLM-5-FP8"
|
|
schema_version: 1
|
|
sha256: "60d8743ec190cc64"
|
|
---
|
|
|
|
# Documentation: DTS.Common.Strings (Strings.Designer.cs)
|
|
|
|
## 1. Purpose
|
|
|
|
This module is an **auto-generated strongly-typed resource class** that provides localized string constants for the DTS CommonCore library. It serves as the central access point for UI strings, error messages, status labels, and configuration descriptions used throughout the DTS system. The class wraps a `.resx` resource file, enabling localization and consistent string management across the application. **This file is machine-generated** by the `StronglyTypedResourceBuilder` tool and should not be manually edited.
|
|
|
|
---
|
|
|
|
## 2. Public Interface
|
|
|
|
### Class: `DTS.Common.Strings.Strings`
|
|
|
|
All members are `static`. The class cannot be instantiated (internal constructor).
|
|
|
|
| Member | Signature | Description |
|
|
|--------|-----------|-------------|
|
|
| `ResourceManager` | `public static global::System.Resources.ResourceManager ResourceManager { get; }` | Returns the cached `ResourceManager` instance for this assembly. Lazily initialized on first access. The resource base name is `"DTS.Common.Strings.Strings"`. |
|
|
| `Culture` | `public static global::System.Globalization.CultureInfo Culture { get; set; }` | Gets or sets the current `CultureInfo` for resource lookups. Overrides the thread's `CurrentUICulture` for all lookups via this class. |
|
|
|
|
### Selected String Properties (partial list — file is truncated)
|
|
|
|
All string properties follow the pattern: `public static string PropertyName { get; }` and call `ResourceManager.GetString("key", resourceCulture)`.
|
|
|
|
| Property | Default Value (English) | Context |
|
|
|----------|------------------------|---------|
|
|
| `ActiveValue` | "Active value" | General status |
|
|
| `Analog` | "Bridge" | Hardware type |
|
|
| `Armed` | "Armed" | System status |
|
|
| `ArmSystem_WaitingForNextInterval` | "Waiting for next interval" | Arming workflow |
|
|
| `BAD_NETPATH_ERROR_MSG` | "Could not connect to network path, please check network connections" | Network error |
|
|
| `BRIDGETYPE_ACC_DESCRIPTION` | "ACC" | Bridge type |
|
|
| `BRIDGETYPE_ARS_DESCRIPTION` | "ARS" | Bridge type |
|
|
| `BRIDGETYPE_IEPE_DESCRIPTION` | "IEPE" | Bridge type |
|
|
| `CAC_Capacity` | "Capacity" | Calibration |
|
|
| `CalculatedChannel_Average` | "Average" | Calculated channel type |
|
|
| `CalculatedChannel_IRTRACC3D_Abdomen` | "3D IR-TRACC (abdomen)" | IR-TRACC sensor position |
|
|
| `CalculatedChannel_Resultant` | "Resultant" | Calculated channel type |
|
|
| `CalibrationBehaviors_LinearIfAvailable` | "Use linear sensitivity, if available" | Calibration behavior |
|
|
| `ClockSyncProfile_Auto_E2E` | "PTP (E2E) Automatic" | Clock synchronization profile |
|
|
| `ClockSyncProfile_Disabled` | "Disabled" | Clock synchronization profile |
|
|
| `ClockSyncProfile_GPS` | "GPS In" | Clock synchronization profile |
|
|
| `ClockSyncProfile_IRIG` | "IRIG B In" | Clock synchronization profile |
|
|
| `DASStatus_ARMED` | "Armed" | DAS (Data Acquisition System) status |
|
|
| `DASStatus_Offline` | "Offline" | DAS status |
|
|
| `DASStatus_Online` | "Online" | DAS status |
|
|
| `DASStatus_READYFORDL` | "Ready for download" | DAS status |
|
|
| `DigitalInputMode_CCNC` | "Contact closure normally closed" | Digital input mode |
|
|
| `DigitalInputMode_TLH` | "Transition low to high" | Digital input mode |
|
|
| `FilterClassType_CFC1000` | "CFC 1000 (A)" | Filter class (ISO 6487) |
|
|
| `FilterClassType_CFC600` | "CFC 600 (B)" | Filter class |
|
|
| `FilterClassType_Unfiltered` | "Unfiltered (0)" | Filter class |
|
|
| `GeneratingPSD` | "Calculating PSD... ({0})" | PSD calculation progress |
|
|
| `GeneratingPSD_CalculatingFFTs` | "Calculating FFTs" | FFT processing status |
|
|
| `HIC` | "HIC" | Head Injury Criterion |
|
|
| `IEPE` | "IEPE" | Integrated Electronics Piezo-Electric |
|
|
| `InputClockSource_GPS` | "GPS" | Clock source |
|
|
| `InputClockSource_IRIG` | "IRIG B" | Clock source |
|
|
| `InvalidCharacterInSerialNumber` | "Error: Invalid character in serial number," | Validation error |
|
|
| `ISO13499Code` | "ISO (13499) code" | ISO-MME standard |
|
|
| `LevelTrigger_GreaterThan` | "Greater than" | Trigger condition |
|
|
| `LevelTrigger_TriggerInside` | "between {0} and {1} ({2})" | Trigger condition (formatted) |
|
|
| `NotApplicable` | "N/A" | General placeholder |
|
|
|
|
*(The source file is truncated; additional properties exist but are not visible in the provided excerpt.)*
|
|
|
|
---
|
|
|
|
## 3. Invariants
|
|
|
|
1. **Auto-generation marker**: The file is decorated with `GeneratedCodeAttribute` indicating tool generation. Manual edits will be overwritten.
|
|
2. **Singleton ResourceManager**: The `ResourceManager` property lazily initializes exactly one instance and caches it in the private `resourceMan` field.
|
|
3. **Thread-safety of ResourceManager initialization**: Uses a temporary local variable pattern (`temp`) before assigning to the static field to avoid race conditions.
|
|
4. **Immutable property signatures**: All string properties are read-only getters; there are no setters.
|
|
5. **Resource base name**: The ResourceManager is initialized with the base name `"DTS.Common.Strings.Strings"` and the executing assembly.
|
|
6. **Internal constructor**: The `Strings()` constructor is marked `internal` with a suppression for `CA1811` (AvoidUncalledPrivateCode), preventing external instantiation.
|
|
|
|
---
|
|
|
|
## 4. Dependencies
|
|
|
|
### This module depends on:
|
|
- `System.Resources.ResourceManager` — for resource lookup
|
|
- `System.Globalization.CultureInfo` — for culture-specific string retrieval
|
|
- `System.CodeDom.Compiler` — for `GeneratedCodeAttribute`
|
|
- `System.Diagnostics` — for `DebuggerNonUserCodeAttribute`
|
|
- `System.Runtime.CompilerServices` — for `CompilerGeneratedAttribute`
|
|
- `System.ComponentModel` — for `EditorBrowsableAttribute`
|
|
- `System.Diagnostics.CodeAnalysis` — for `SuppressMessageAttribute`
|
|
|
|
### The underlying `.resx` file:
|
|
- A companion file `Strings.resx` (not shown) contains the actual key-value pairs and is the source for this designer file.
|
|
|
|
### What depends on this module:
|
|
- **Unknown from source alone** — any component in the DTS codebase that requires localized strings may reference `DTS.Common.Strings.Strings`.
|
|
|
|
---
|
|
|
|
## 5. Gotchas
|
|
|
|
1. **Do not edit this file directly** — The auto-generated header explicitly warns that changes will be lost if the code is regenerated. To add or modify strings, edit the `.resx` file and regenerate.
|
|
|
|
2. **File is truncated in the provided source** — The source cuts off mid-property (`OutputClockSource_PTP_OnePPS`). The full file contains additional string properties not documented here.
|
|
|
|
3. **Culture can be overridden globally** — Setting `Strings.Culture` affects all subsequent resource lookups through this class. Callers should be aware this is a global setting.
|
|
|
|
4. **Formatted strings require caller handling** — Properties like `LevelTrigger_TriggerInside` contain format placeholders (`{0}`, `{1}`, `{2}`). The caller is responsible for calling `string.Format()` or similar.
|
|
|
|
5. **Typo in property name**: `DigitialOutput` (should be `DigitalOutput`) — this appears to be a historical naming quirk preserved for backward compatibility.
|
|
|
|
6. **Some strings contain newlines and formatting** — e.g., `DockingStationNotFound` contains multi-line instructions with bullet points. Callers displaying these should preserve formatting. |