66 lines
3.0 KiB
Markdown
66 lines
3.0 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common/Enums/Channels/ChannelCodeType.cs
|
||
|
|
generated_at: "2026-04-17T16:40:22.843052+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "a889ef7dd7c871e6"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: ChannelCodeType.cs
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines channel code type classifications for the DTS system, providing both an enumeration and associated constants. It establishes the distinction between ISO-standardized channel codes (conforming to ISO 13499) and user-defined channel codes, along with their respective string representations and length constraints. This serves as a foundational reference for channel code validation and type checking throughout the system.
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### Class: `ChannelEnumsAndConstants`
|
||
|
|
|
||
|
|
A container class housing channel-related enumeration and constants.
|
||
|
|
|
||
|
|
#### Constants
|
||
|
|
|
||
|
|
| Name | Type | Value | Description |
|
||
|
|
|------|------|-------|-------------|
|
||
|
|
| `IsoCodeTypeString` | `string` | `"ISO 13499"` | String representation for ISO channel code type |
|
||
|
|
| `UserCodeTypeString` | `string` | `"User"` | String representation for User-defined channel code type |
|
||
|
|
| `ISO_CODE_LENGTH` | `int` | `16` | Maximum/expected length for ISO channel codes |
|
||
|
|
| `USER_CODE_LENGTH` | `int` | `50` | Maximum/expected length for user-defined channel codes |
|
||
|
|
|
||
|
|
#### Enum: `ChannelCodeType`
|
||
|
|
|
||
|
|
Nested enumeration representing channel code classification.
|
||
|
|
|
||
|
|
| Member | Value | Description |
|
||
|
|
|--------|-------|-------------|
|
||
|
|
| `ISO` | `0` | Represents ISO 13499 standardized channel codes |
|
||
|
|
| `User` | `1` | Represents user-defined channel codes |
|
||
|
|
|
||
|
|
## 3. Invariants
|
||
|
|
|
||
|
|
- ISO channel codes must have a length of exactly `16` characters (as defined by `ISO_CODE_LENGTH`).
|
||
|
|
- User-defined channel codes must have a length of up to `50` characters (as defined by `USER_CODE_LENGTH`).
|
||
|
|
- The string representation `"ISO 13499"` corresponds to `ChannelCodeType.ISO`.
|
||
|
|
- The string representation `"User"` corresponds to `ChannelCodeType.User`.
|
||
|
|
- The enum values are implicitly ordered: `ISO = 0`, `User = 1`.
|
||
|
|
|
||
|
|
## 4. Dependencies
|
||
|
|
|
||
|
|
### Dependencies (what this module imports)
|
||
|
|
- **None** - This module is self-contained with no external imports or references.
|
||
|
|
|
||
|
|
### Dependents (what depends on this module)
|
||
|
|
- **Unknown** - No consumers are visible in the provided source. Other modules in the `DTS.Common.Enums.Channels` namespace or broader `DTS.Common` assembly likely reference this, but this cannot be confirmed from the source alone.
|
||
|
|
|
||
|
|
## 5. Gotchas
|
||
|
|
|
||
|
|
1. **Naming inconsistency**: The class is named `ChannelEnumsAndConstants` (plural, suggesting multiple enums), but the file is named `ChannelCodeType.cs`. The class contains only one enum, making the class name potentially misleading.
|
||
|
|
|
||
|
|
2. **Inconsistent constant naming convention**: The code mixes naming styles:
|
||
|
|
- `IsoCodeTypeString` and `UserCodeTypeString` use PascalCase
|
||
|
|
- `ISO_CODE_LENGTH` and `USER_CODE_LENGTH` use SCREAMING_SNAKE_CASE
|
||
|
|
|
||
|
|
This may cause confusion about which convention to follow when extending.
|
||
|
|
|
||
|
|
3. **String-to-enum mismatch**:
|