70 lines
2.8 KiB
Markdown
70 lines
2.8 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common.Import/ImportOptions/EqxImportOptions.cs
|
||
|
|
- Common/DTS.Common.Import/ImportOptions/CsvImportOptions.cs
|
||
|
|
generated_at: "2026-04-17T16:36:19.520206+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "edba9a74df78fb33"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: DTS.Common.Import.ImportOptions
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines configuration option classes for the DTS import subsystem. It provides strongly-typed containers for import behavior settings, specifically for EQX-format imports and CSV-format imports. These classes serve as parameter objects that control how data is parsed, validated, and persisted during import operations.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### `EqxImportOptions`
|
||
|
|
|
||
|
|
A configuration class for EQX-format imports.
|
||
|
|
|
||
|
|
| Property | Type | Default | Description |
|
||
|
|
|----------|------|---------|-------------|
|
||
|
|
| `OverwriteExistingSensors` | `bool` | `true` | Controls whether existing sensors should be overwritten during import. |
|
||
|
|
| `ImportSensorModels` | `bool` | `true` | Controls whether sensor models should be imported. |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `CsvImportOptions`
|
||
|
|
|
||
|
|
A configuration class for CSV-format imports.
|
||
|
|
|
||
|
|
| Property | Type | Default | Description |
|
||
|
|
|----------|------|---------|-------------|
|
||
|
|
| `Encoding` | `string` | None (uninitialized) | Specifies the character encoding for parsing the CSV file. |
|
||
|
|
| `FieldSeparator` | `string` | None (uninitialized) | Specifies the delimiter character(s) used to separate fields. |
|
||
|
|
| `ImportCulture` | `CultureInfo` | None (uninitialized) | Specifies the culture settings for parsing culture-dependent values (e.g., number formats, dates). |
|
||
|
|
| `StripBackSlash` | `bool` | None (uninitialized) | Controls whether backslash characters should be removed during import. |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `ZeroMethodOptions`
|
||
|
|
|
||
|
|
A configuration class for zero method settings (appears related to sensor calibration/offset handling).
|
||
|
|
|
||
|
|
| Property | Type | Default | Description |
|
||
|
|
|----------|------|---------|-------------|
|
||
|
|
| `ZeroMethodType` | `ZeroMethodType` | None (uninitialized) | Specifies the type of zero method to apply. |
|
||
|
|
| `ZeroMethodStart` | `double` | None (uninitialized) | Specifies the start value for the zero method range. |
|
||
|
|
| `ZeroMethodEnd` | `double` | None (uninitialized) | Specifies the end value for the zero method range. |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 3. Invariants
|
||
|
|
|
||
|
|
- **EqxImportOptions**: Both boolean properties (`OverwriteExistingSensors`, `ImportSensorModels`) are always initialized to `true` by default.
|
||
|
|
- **CsvImportOptions**: No default values are enforced by the class; properties may be `null` if not explicitly set.
|
||
|
|
- **ZeroMethodOptions**: No default values are enforced by the class; properties may be `null` or `0` (for value types) if not explicitly set.
|
||
|
|
- No validation logic is present in these classes; any constraints must be enforced by consumers.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 4. Dependencies
|
||
|
|
|
||
|
|
### This module depends on:
|
||
|
|
- `System` (core BCL types)
|
||
|
|
- `
|