46 lines
2.3 KiB
Markdown
46 lines
2.3 KiB
Markdown
---
|
|
source_files:
|
|
- DataPRO/Modules/Channels/ChannelCodes/ChannelCodesModule.cs
|
|
generated_at: "2026-04-17T16:47:17.153049+00:00"
|
|
model: "zai-org/GLM-5-FP8"
|
|
schema_version: 1
|
|
sha256: "7676c98280386b11"
|
|
---
|
|
|
|
# ChannelCodesModule Documentation
|
|
|
|
## 1. Purpose
|
|
|
|
The `ChannelCodesModule` is a Prism module that provides Channel Codes functionality within the DTS application framework. It exists to modularize channel code management features, registering its views and view models with the Unity dependency injection container. The module is categorized under the "Prepare" assembly group and exposes metadata (name and image) for display in the main application's module summary screen.
|
|
|
|
## 2. Public Interface
|
|
|
|
### ChannelCodesModule
|
|
**Signature:** `public class ChannelCodesModule : IModule`
|
|
|
|
The main module class responsible for DI registration.
|
|
|
|
| Member | Signature | Description |
|
|
|--------|-----------|-------------|
|
|
| Constructor | `ChannelCodesModule(IUnityContainer unityContainer)` | Accepts a Unity container via constructor injection and stores it in `_unityContainer`. |
|
|
| Initialize | `void Initialize()` | Registers `IChannelCodesListViewModel` → `ChannelCodesListViewModel` and `IChannelCodesListView` → `ChannelCodesListView` with Unity. |
|
|
| OnInitialized | `void OnInitialized(IContainerProvider containerProvider)` | Empty implementation (no post-initialization logic). |
|
|
| RegisterTypes | `void RegisterTypes(IContainerRegistry containerRegistry)` | Delegates to `Initialize()`. |
|
|
|
|
### ChannelCodesModuleNameAttribute
|
|
**Signature:** `public class ChannelCodesModuleNameAttribute : TextAttribute`
|
|
|
|
Assembly-level attribute providing the module's display name.
|
|
|
|
| Member | Return Type | Description |
|
|
|--------|-------------|-------------|
|
|
| Constructor | `ChannelCodesModuleNameAttribute()` | Default constructor. |
|
|
| Constructor | `ChannelCodesModuleNameAttribute(string s)` | Overloaded constructor accepting a string (unused). |
|
|
| AssemblyName | `string` | Returns `AssemblyNames.ChannelCodes.ToString()`. |
|
|
| GetAttributeType | `Type` | Returns `typeof(TextAttribute)`. |
|
|
| GetAssemblyName | `string` | Returns the `AssemblyName` property value. |
|
|
|
|
### ChannelCodesModuleImageAttribute
|
|
**Signature:** `public class ChannelCodesModuleImageAttribute : ImageAttribute`
|
|
|
|
Assembly-level |