init
This commit is contained in:
@@ -0,0 +1,32 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetupsXMLClass.cs
|
||||
generated_at: "2026-04-17T16:27:18.976880+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "890619d12614e6fe"
|
||||
---
|
||||
|
||||
# TestSetups
|
||||
|
||||
### Purpose
|
||||
This module defines the root XML container class `TestSetupsXMLClass` for serializing and deserializing collections of test setup configurations. It serves as the top-level entry point for XML export/import functionality related to test setups, wrapping an array of individual test setup definitions.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**Class: `TestSetupsXMLClass`**
|
||||
- `TestSetupXMLClass[] TestSetups { get; set; }` - Property decorated with `[XmlElement("TestSetup")]` that holds an array of test setup objects. Serializes each item as a `<TestSetup>` element within the root `<TestSetups>` element.
|
||||
|
||||
### Invariants
|
||||
- The class is decorated with `[XmlRootAttribute("TestSetups")]`, meaning the XML root element must always be named "TestSetups" when serialized.
|
||||
- Each child element in the XML must be named "TestSetup" as defined by the `XmlElement` attribute.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on**: `System.Xml.Serialization` for XML serialization attributes.
|
||||
- **Depends on**: `TestSetupXMLClass` (referenced but not defined in this module; expected to be defined elsewhere in the codebase).
|
||||
- **Dependents**: Unknown from source alone - likely used by XML export/import utilities.
|
||||
|
||||
### Gotchas
|
||||
- None identified from source alone.
|
||||
|
||||
---
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/TestSetupXMLClass.cs
|
||||
generated_at: "2026-04-17T16:09:45.090949+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "6d5d97d1ece504b8"
|
||||
---
|
||||
|
||||
# TestSetup
|
||||
|
||||
### Purpose
|
||||
This module defines `TestSetupXMLClass`, the root container class for XML serialization of test setup configurations. It serves as the top-level data structure for exporting/importing test setup data, aggregating references to DAS (Data Acquisition System) hardware lists, test groups, fields, hardware includes, level triggers, and metadata.
|
||||
|
||||
### Public Interface
|
||||
|
||||
- **`TestSetupXMLClass`** - Root XML container class for test setup export.
|
||||
- `string Id { get; set; }` - Identifier for the test setup.
|
||||
- `List<DASListXMLClass> DASList { get; set; }` - Collection of DAS hardware list configurations. Serialized as XML element "DASList".
|
||||
- `List<GroupsXMLClass> Groups { get; set; }` - Collection of test group configurations. Serialized as XML element "Groups".
|
||||
- `FieldsXMLClass Fields { get; set; }` - Field definitions for the test setup. Serialized as XML element "Fields".
|
||||
- `string HardwareIncludes { get; set; }` - Hardware include references (no XML element attribute specified, uses property name).
|
||||
- `LevelTriggersXMLClass LevelTriggers { get; set; }` - Level trigger configurations. Serialized as XML element "LevelTriggers".
|
||||
- `MetaDatasXMLClass MetaDatas { get; set; }` - Metadata associated with the test setup. Serialized as XML element "MetaDatas".
|
||||
|
||||
### Invariants
|
||||
- All properties are nullable reference types; no null checks or initialization is enforced at the class level.
|
||||
- XML element names are explicitly controlled via `[XmlElement]` attributes for most collection properties.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on**: `System.Xml.Serialization` for XML serialization attributes.
|
||||
- **Depends on**: `DASListXMLClass`, `GroupsXMLClass`, `FieldsXMLClass`, `LevelTriggersXMLClass`, `MetaDatasXMLClass` (referenced but not shown in this batch).
|
||||
- **Depended on by**: Unclear from source alone—likely used by XML import/export utilities in the parent namespace.
|
||||
|
||||
### Gotchas
|
||||
- The `DASList` property is of type `List<DASListXMLClass>` and serialized with `[XmlElement("DASList")]`, which means each item in the list is serialized as a `<DASList>` element, not wrapped in a parent container. This differs from typical `[XmlArray]`/`[XmlArrayItem]` patterns.
|
||||
- `HardwareIncludes` lacks an `[XmlElement]` attribute, so its XML element name defaults to the property name, unlike other properties in this class.
|
||||
|
||||
---
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/DASList/DASListXMLClass.cs
|
||||
generated_at: "2026-04-17T16:09:45.092722+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "fa96a5d390190ffd"
|
||||
---
|
||||
|
||||
# DASList
|
||||
|
||||
### Purpose
|
||||
This module defines `DASListXMLClass`, a container for DAS (Data Acquisition System) hardware configurations. It wraps a collection of hardware definitions used in test setups.
|
||||
|
||||
### Public Interface
|
||||
|
||||
- **`DASListXMLClass`** - Container class for DAS hardware list items.
|
||||
- `List<DASHardwareXMLClass> DASList { get; set; }` - Collection of DAS hardware entries. Serialized as individual XML elements named "DASList".
|
||||
|
||||
### Invariants
|
||||
- The property `DASList` is a nullable reference type with no enforced initialization.
|
||||
- The `[XmlElement("DASList")]` attribute on the `DASList` property causes each `D
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/DASList/DASHardware/DASHardwareXMLClass.cs
|
||||
generated_at: "2026-04-17T16:44:17.178458+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "736ef60c0b25d128"
|
||||
---
|
||||
|
||||
# DASHardwareXMLClass Documentation
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
`DASHardwareXMLClass` is a data transfer object (DTO) designed for XML serialization of Data Acquisition System (DAS) hardware configuration within the test setup export framework. It serves as a serializable representation of hardware settings, capturing three key properties: device identification via serial number, sampling rate configuration, and clock master status. The class resides in the `DTS.Common.XMLUtils` namespace under a path structure suggesting it is part of a hierarchical test setup export system.
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### Class: `DASHardwareXMLClass`
|
||||
|
||||
**Namespace:** `DTS.Common.XMLUtils`
|
||||
|
||||
**Properties:**
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `SerialNumber` | `string` | Gets or sets the hardware device serial number identifier. |
|
||||
| `SamplesPerSecond` | `string` | Gets or sets the sampling rate configuration value. |
|
||||
| `IsClockMaster` | `string` | Gets or sets the clock master status indicator. |
|
||||
|
||||
All properties are public read/write auto-implemented properties with no backing field logic or validation.
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- All three properties (`SerialNumber`, `SamplesPerSecond`, `IsClockMaster`) are of type `string`, regardless of their semantic meaning.
|
||||
- Properties are nullable by default; no constructor initializes them to default values.
|
||||
- No XML serialization attributes (e.g., `[XmlElement]`, `[XmlAttribute]`) are applied to the properties, so default XML serialization behavior applies—elements will be named after the properties.
|
||||
- The class contains no validation logic; any string value (including empty or null) is acceptable for all properties.
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
**This module depends on:**
|
||||
- `System` (namespace)
|
||||
- `System.Collections.Generic` (namespace, imported but not directly used)
|
||||
- `System.Linq` (namespace, imported but not directly used)
|
||||
- `System.Text` (namespace, imported but not directly used)
|
||||
- `System.Threading.Tasks` (namespace, imported but not directly used)
|
||||
- `System.Xml.Serialization` (namespace, imported for XML serialization infrastructure)
|
||||
|
||||
**What depends on this module:**
|
||||
- Cannot be determined from the source alone. The namespace path (`TestSetupExportXML/TestSetups/TestSetup/DASList/DASHardware`) suggests parent container classes within the same module hierarchy likely reference this class.
|
||||
|
||||
## 5. Gotchas
|
||||
|
||||
1. **Type choices are non-obvious:** `SamplesPerSecond` and `IsClockMaster` are declared as `string` rather than their logical types (`int` or `double` for sampling rate; `bool` for clock master status). This may indicate requirements for XML interoperability, legacy format compatibility, or handling of special string values (e.g., "N/A", "Unknown").
|
||||
|
||||
2. **Unused imports:** The file imports `System.Collections.Generic`, `System.Linq`, `System.Text`, and `System.Threading.Tasks`, but none are used in the class. This
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/Fields/FieldsXMLClass.cs
|
||||
generated_at: "2026-04-17T16:27:20.515620+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "f56848e6c1bf4cc4"
|
||||
---
|
||||
|
||||
# Fields
|
||||
|
||||
### Purpose
|
||||
`FieldsXMLClass` is a data transfer object (DTO) designed for XML serialization/deserialization of test setup configuration fields. It serves as the primary container for all configurable parameters of a test setup in the DTS system, capturing settings related to test execution, data acquisition, triggering, recording, export options, and metadata. This class likely maps directly to an XML schema for test setup import/export functionality.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**Class: `FieldsXMLClass`**
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `SetupName` | `string` | Name identifier for the test setup |
|
||||
| `SetupDescription` | `string` | Human-readable description of the test setup |
|
||||
| `AutomaticTestProgression` | `string` | Controls automatic progression through test steps |
|
||||
| `AutomaticProgressionDelayMS` | `string` | Delay in milliseconds between automatic progressions |
|
||||
| `InvertTrigger` | `string` | Trigger signal inversion setting |
|
||||
| `InvertStart` | `string` | Start signal inversion setting |
|
||||
| `IgnoreShortedStart` | `string` | Whether to ignore shorted start condition |
|
||||
| `IgnoreShortedTrigger` | `string` | Whether to ignore shorted trigger condition |
|
||||
| `ViewDiagnostics` | `string` | Diagnostic view configuration |
|
||||
| `VerifyChannels` | `string` | Channel verification setting |
|
||||
| `AutoVerifyChannels` | `string` | Automatic channel verification flag |
|
||||
| `VerifyChannelsDelayMS` | `string` | Delay for channel verification in milliseconds |
|
||||
| `RecordingMode` | `string` | Data recording mode configuration |
|
||||
| `SamplesPerSecond` | `string` | Sample rate for data acquisition |
|
||||
| `PreTriggerSeconds` | `string` | Pre-trigger recording duration |
|
||||
| `PostTriggerSeconds` | `string` | Post-trigger recording duration |
|
||||
| `NumberOfEvents` | `string` | Number of events to capture |
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/Groups/GroupsXMLClass.cs
|
||||
generated_at: "2026-04-17T16:43:40.225919+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "1f7f24bb17ddad98"
|
||||
---
|
||||
|
||||
# Documentation: GroupsXMLClass
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
`GroupsXMLClass` is an XML serialization data transfer object that represents a collection of groups within the test setup export hierarchy. It serves as a container for multiple `GroupXMLClass` instances and is designed to be serialized to/deserialized from XML with a specific schema where each group is represented as a `<Group>` element. This class is part of the broader `DTS.Common.XMLUtils` infrastructure for test setup configuration management.
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### Class: `GroupsXMLClass`
|
||||
|
||||
**Namespace:** `DTS.Common.XMLUtils`
|
||||
|
||||
**Property:**
|
||||
|
||||
| Name | Type | XML Attribute | Description |
|
||||
|------|------|---------------|-------------|
|
||||
| `Group` | `List<GroupXMLClass>` | `[XmlElement("Group")]` | A collection of group objects. Each item in the list will be serialized as a `<Group>` XML element. |
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- The `Group` property is decorated with `[XmlElement("Group")]`, ensuring that during XML serialization, each item in the list is output as an individual `<Group>` element rather than a wrapping array element.
|
||||
- The property is nullable (not initialized in a constructor), so consumers should handle potential `null` values when accessing it.
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
**This module depends on:**
|
||||
- `System.Xml.Serialization` - For the `XmlElement` attribute used to control XML serialization behavior.
|
||||
- `GroupXMLClass` - A referenced type that is not included in the provided source. The definition and structure of this class are unknown from the given source alone.
|
||||
|
||||
**Dependents:**
|
||||
- Cannot be determined from this single source file alone. Based on the file path, this class is likely used by parent XML classes in the `TestSetup` hierarchy.
|
||||
|
||||
## 5. Gotchas
|
||||
|
||||
- **Null handling:** The `Group` property is not initialized in a default constructor. Code accessing this property should check for `null` before iterating or accessing list members, as deserialization may leave it `null` if no `<Group>` elements are present in the source XML.
|
||||
- **Missing type definition:** `GroupXMLClass` is referenced but not defined in the provided source. Its structure and behavior cannot be documented here.
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/Groups/Group/GroupXMLClass.cs
|
||||
generated_at: "2026-04-17T16:09:50.921360+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "0a9577ddc3f4a22f"
|
||||
---
|
||||
|
||||
# Group
|
||||
|
||||
### Purpose
|
||||
`GroupXMLClass` is an XML-serializable data transfer object representing a test group within a test setup hierarchy. It serves as a container for grouping related test channels and hardware configurations, capturing metadata such as group identification, display properties, and positional information for test execution ordering.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**Constructor:**
|
||||
- `GroupXMLClass()` - Initializes a new instance with `HardwareList` set to a new `HardwareListXMLClass` instance and `Channel` set to an empty `List<ChannelXMLClass>`.
|
||||
|
||||
**Properties:**
|
||||
- `string Name { get; set; }` - Internal name identifier for the group.
|
||||
- `string DisplayName { get; set; }` - Human-readable name for UI display.
|
||||
- `string Description { get; set; }` - Textual description of the group.
|
||||
- `string TestSetupName { get; set; }` - Name of the parent test setup.
|
||||
- `string DisplayOrder { get; set; }` - Ordering value for UI presentation.
|
||||
- `string Position { get; set; }` - Positional identifier.
|
||||
- `string TestObjectType { get; set; }` - Type classification of the test object.
|
||||
- `string Id { get; set; }` - Unique identifier for the group.
|
||||
- `string StaticGroupId { get; set; }` - Reference to a static group definition.
|
||||
- `HardwareListXMLClass HardwareList { get; set; }` - XML element mapped collection of hardware references.
|
||||
- `List<ChannelXMLClass> Channel { get; set; }` - XML element mapped collection of channel configurations.
|
||||
|
||||
### Invariants
|
||||
- `HardwareList` and `Channel` are never null after construction (initialized in constructor).
|
||||
- All scalar properties are nullable strings; no type enforcement on numeric fields like `DisplayOrder`, `Position`, `DASChannelIdx`.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on:** `HardwareListXMLClass`, `ChannelXMLClass`, `System.Xml.Serialization` (for `XmlElement` attribute).
|
||||
- **Depended on by:** Not shown in source; likely used by parent `Groups` or `TestSetup` container classes.
|
||||
|
||||
### Gotchas
|
||||
- Numeric fields (`DisplayOrder`, `Position`) are stored as strings, requiring parsing by consumers.
|
||||
- The `Channel` property uses `[XmlElement("Channel")]`, meaning each item serializes as a direct child element rather than wrapped in a parent container.
|
||||
|
||||
---
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/Groups/Group/Channel/ChannelXMLClass.cs
|
||||
generated_at: "2026-04-17T16:42:51.191961+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "01693602c2b05efd"
|
||||
---
|
||||
|
||||
# Documentation: ChannelXMLClass
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
`ChannelXMLClass` is a data transfer object designed for XML serialization of channel configuration data within a test setup export hierarchy. It represents a single channel's metadata, including ISO-standard identifiers, user-defined names, hardware mapping information (DAS/Sensor), and ordering context within test setups and groups. This class exists to facilitate the export and import of test setup configurations in a structured XML format.
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### Class: `ChannelXMLClass`
|
||||
**Namespace:** `DTS.Common.XMLUtils`
|
||||
|
||||
#### Constructor
|
||||
|
||||
| Signature | Description |
|
||||
|-----------|-------------|
|
||||
| `ChannelXMLClass()` | Default constructor that initializes the `Settings` property to a new instance of `SettingsXMLClass`. |
|
||||
|
||||
#### Properties
|
||||
|
||||
| Name | Type | XML Attribute | Description |
|
||||
|------|------|---------------|-------------|
|
||||
| `ISOChannelName` | `string` | Default | ISO-standard channel name identifier. |
|
||||
| `ISOCode` | `string` | Default | ISO code associated with the channel. |
|
||||
| `UserChannelName` | `string` | Default | User-defined channel name. |
|
||||
| `UserCode` | `string` | Default | User-defined code for the channel. |
|
||||
| `Disabled` | `string` | Default | Flag indicating whether the channel is disabled. |
|
||||
| `Settings` | `SettingsXMLClass` | `[XmlElement("Settings")]` | Nested configuration settings for the channel. Guaranteed non-null after construction. |
|
||||
| `SensorId` | `string` | Default | Identifier for the sensor associated with this channel. |
|
||||
| `DASId` | `string` | Default | Data Acquisition System identifier. |
|
||||
| `DASChannelIdx` | `string` | Default | Index of the channel within the DAS. |
|
||||
| `TestSetupOrder` | `string` | Default | Ordering position within the test setup. |
|
||||
| `GroupOrder` | `string` | Default | Ordering position within the group. |
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- **Settings Non-Null Guarantee:** The `Settings` property is initialized in the constructor and will never be `null` immediately after construction. However, it can be set to `null` via the property setter after construction.
|
||||
- **All Properties Are Strings:** All scalar properties are of type `string`, including properties that semantically represent numeric values (`DASChannelIdx`, `TestSetupOrder`, `GroupOrder`) or boolean states (`Disabled`).
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
### This Module Depends On:
|
||||
- `System` (standard library)
|
||||
- `System.Collections.Generic` (standard library, imported but not directly used in this file)
|
||||
- `System.Linq` (standard library, imported but not directly used in this file)
|
||||
- `System.Text` (standard library, imported but not directly used in this file)
|
||||
- `System.Threading.Tasks` (standard library, imported but not directly used in this file)
|
||||
- `System.Xml.Serialization` - Used for `XmlElementAttribute` on the `Settings` property
|
||||
- `SettingsXMLClass` - External
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/Groups/Group/Channel/Settings/SettingsXMLClass.cs
|
||||
generated_at: "2026-04-17T16:10:09.734860+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "86eda6e2c5e43fb5"
|
||||
---
|
||||
|
||||
# Settings
|
||||
|
||||
### Purpose
|
||||
This module provides a data transfer object (`SettingsXMLClass`) for representing channel settings configuration within the test setup XML export hierarchy. It serves as a serializable container for channel-specific acquisition parameters such as filter settings, polarity, range, and zero method configuration.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**Class: `SettingsXMLClass`**
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `FilterClass` | `string` | Gets or sets the filter class setting. |
|
||||
| `Polarity` | `string` | Gets or sets the polarity setting. |
|
||||
| `Range` | `string` | Gets or sets the range setting. |
|
||||
| `ZeroMethod` | `string` | Gets or sets the zero method identifier. |
|
||||
| `ZeroMethodStart` | `string` | Gets or sets the zero method start value. |
|
||||
| `ZeroMethodEnd` | `string` | Gets or sets the zero method end value. |
|
||||
| `InitialOffset` | `string` | Gets or sets the initial offset value. |
|
||||
| `UserValue1` | `string` | Gets or sets the first user-defined value. |
|
||||
| `UserValue2` | `string` | Gets or sets the second user-defined value. |
|
||||
| `UserValue3` | `string` | Gets or sets the third user-defined value. |
|
||||
|
||||
### Invariants
|
||||
- All properties are nullable strings with no enforced validation.
|
||||
- The class is mutable; property values can be changed after instantiation.
|
||||
|
||||
### Dependencies
|
||||
- **Depends on:** `System`, `System.Collections.Generic`, `System.Linq`, `System.Text`, `System.Threading.Tasks` (all standard .NET namespaces; some may be unused residuals).
|
||||
- **Dependents:** Unclear from source alone—likely consumed by XML serialization logic in parent `Channel` module.
|
||||
|
||||
### Gotchas
|
||||
- All properties are typed as `string`, even those that may represent numeric values (e.g., `Range`, `InitialOffset`). Parsing/conversion is the consumer's responsibility.
|
||||
- The class lacks XML serialization attributes, suggesting it may be serialized via element members rather than attributes, or handled by a parent serializer.
|
||||
|
||||
---
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/Groups/Group/HardwareList/HardwareListXMLClass.cs
|
||||
generated_at: "2026-04-17T16:09:50.923287+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "87ba0d57434e0e01"
|
||||
---
|
||||
|
||||
# HardwareList
|
||||
|
||||
### Purpose
|
||||
`HardwareListXMLClass` is an XML-serializable container for a collection of hardware identifiers associated with a test group. It provides a simple wrapper to serialize a list of hardware names as individual XML elements under a parent `HardwareList` element.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**Constructor:**
|
||||
- `HardwareListXMLClass()` - Initializes a new instance with `Hardware` set to an empty `List<string>`.
|
||||
|
||||
**Properties:**
|
||||
- `List
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/Groups/Group/HardwareList/Hardware/HardwareXMLClass.cs
|
||||
generated_at: "2026-04-17T16:09:50.924144+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "a9283109436d1a32"
|
||||
---
|
||||
|
||||
# Hardware
|
||||
|
||||
### Purpose
|
||||
`HardwareListXMLClass` is an XML-serializable container for a collection of hardware identifiers associated with a test group. It provides a simple wrapper to serialize a list of hardware names as individual XML elements under a parent `HardwareList` element.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**Constructor:**
|
||||
- `HardwareListXMLClass()` - Initializes a new instance with `Hardware` set to an empty `List<string>`.
|
||||
|
||||
**Properties:**
|
||||
- `List
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/LevelTriggers/LevelTriggersXMLClass.cs
|
||||
generated_at: "2026-04-17T16:43:56.737975+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "184ba6af6cff8211"
|
||||
---
|
||||
|
||||
# LevelTriggersXMLClass Documentation
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
`LevelTriggersXMLClass` is an XML serialization data transfer object that serves as a container for a collection of level trigger configurations within the test setup export system. It exists to facilitate the serialization and deserialization of level trigger data to/from XML format, acting as an intermediate representation in the test setup export pipeline.
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### Class: `LevelTriggersXMLClass`
|
||||
|
||||
**Namespace:** `DTS.Common.XMLUtils`
|
||||
|
||||
| Member | Signature | Description |
|
||||
|--------|-----------|-------------|
|
||||
| `LevelTriggers` | `public List<LevelTriggerXMLClass> LevelTriggers { get; set; }` | A list of level trigger definitions. Decorated with `[XmlElement("LevelTrigger")]`, causing each item in the list to be serialized as an individual `<LevelTrigger>` XML element. |
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- The class is designed specifically for XML serialization via `XmlSerializer`.
|
||||
- The XML element name for each list item is explicitly defined as `"LevelTrigger"` (singular), regardless of the property name being plural.
|
||||
- The property `LevelTriggers` has no default initialization in the class; it may be `null` if not explicitly set before serialization.
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
### This module depends on:
|
||||
- `System.Xml.Serialization` — for `[XmlElement]` attribute
|
||||
- `System.Collections.Generic` — for `List<T>`
|
||||
- `LevelTriggerXMLClass` — the element type for the `LevelTriggers` list (defined elsewhere, not in provided source)
|
||||
|
||||
### What depends on this module:
|
||||
- **Unknown from source alone.** The class is referenced by its namespace path suggesting it is part of a larger test setup export XML hierarchy, but the specific consumers are not visible in the provided source.
|
||||
|
||||
## 5. Gotchas
|
||||
|
||||
- **Null reference risk:** The `LevelTriggers` property is not initialized (no constructor or field initializer). Code consuming instances of this class should handle potential `null` values, especially after deserialization if the XML contains no `<LevelTrigger>` elements.
|
||||
- **Element naming mismatch:** The XML element name (`"LevelTrigger"`) differs from the property name (`LevelTriggers`). This is intentional for XML convention compliance but may cause confusion when mapping between XML and code.
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/LevelTriggers/LevelTrigger/LevelTriggerXMLClass.cs
|
||||
generated_at: "2026-04-17T16:10:09.736543+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "1b5f2b140395edd8"
|
||||
---
|
||||
|
||||
# LevelTrigger
|
||||
|
||||
### Purpose
|
||||
This module provides a data transfer object (`LevelTriggerXMLClass`) for representing level trigger configuration within the test setup XML export hierarchy. It captures trigger conditions (greater-than/less-than thresholds), channel identification, and engineering unit bounds for triggering behavior.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**Class: `LevelTriggerXMLClass`**
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `GroupChannelId` | `string` | Gets or sets the group channel identifier (serialized as XML attribute). |
|
||||
| `HardwareChannelId` | `string` | Gets or sets the hardware channel identifier (serialized as XML attribute). |
|
||||
| `SensorSerialNumber` | `string` | Gets or sets the sensor serial number (serialized as XML attribute). |
|
||||
| `GreaterThanEnabled` | `string` | Gets or sets whether the greater-than trigger is enabled (serialized as XML attribute). |
|
||||
| `GreaterThanValue` | `string` | Gets or sets the greater-than threshold value (serialized as XML attribute). |
|
||||
| `LessThanEnabled` | `string` | Gets or sets whether the less-than trigger is enabled (serialized as XML attribute). |
|
||||
| `LessThanValue` | `string` | Gets or sets the less-than threshold value (serialized as XML attribute). |
|
||||
| `TriggerInside` | `string` | Gets or sets the trigger-inside configuration (serialized as XML attribute). |
|
||||
| `TriggerOutside` | `string` | Gets or sets the trigger-outside configuration (serialized as XML attribute). |
|
||||
| `InsideLowerEU` | `string` |
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/MetaDatas/MetaDatasXMLClass.cs
|
||||
generated_at: "2026-04-17T16:27:18.979714+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "d104e378a874e8e8"
|
||||
---
|
||||
|
||||
# MetaDatas
|
||||
|
||||
### Purpose
|
||||
This module defines `MetaDatasXMLClass`, a container class for holding a collection of metadata entries associated with a test setup. It enables XML serialization of multiple `<MetaData>` elements as a structured list.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**Class: `MetaDatasXMLClass`**
|
||||
- `List<MetaDataXMLClass> MetaDatas { get; set; }` - Property decorated with `[XmlElement("MetaData")]` that holds a list of metadata objects. Serializes each item as a `<MetaData>` element.
|
||||
|
||||
### Invariants
|
||||
- Each child element in the XML must be named "MetaData" as
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common/XMLUtils/TestSetupExportXML/TestSetups/TestSetup/MetaDatas/MetaData/MetaDataXMLClass.cs
|
||||
generated_at: "2026-04-17T16:43:03.360314+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "abc1776fbf79c497"
|
||||
---
|
||||
|
||||
# Documentation: MetaDataXMLClass
|
||||
|
||||
## 1. Purpose
|
||||
The `MetaDataXMLClass` serves as a data transfer object (DTO) designed for XML serialization within the `DTS.Common.XMLUtils` namespace. It represents a single metadata entry associated with a test setup, mapping specific test configuration details—such as test object identification, setup names
|
||||
Reference in New Issue
Block a user