init
This commit is contained in:
119
docs/ai/Common/DTS.Common.Storage/Classes/Abstract.md
Normal file
119
docs/ai/Common/DTS.Common.Storage/Classes/Abstract.md
Normal file
@@ -0,0 +1,119 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/MMEPossibleChannels.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/DbVersions.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/Settings.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/VersionTable.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/TestObjectChannelSettings.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/Tags.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/DigitalOutputSettings.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/LabratoryDetails.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/Squib.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/CalculatedChannels.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/Users.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/LevelTriggers.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/SensorDB.cs
|
||||
- Common/DTS.Common.Storage/Classes/Abstract/TestSetups.cs
|
||||
generated_at: "2026-04-17T15:29:31.320582+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "4094b0b2b65e3c70"
|
||||
---
|
||||
|
||||
# Documentation: DTS.Common.Storage Schema Definitions
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module provides abstract class definitions that serve as database schema constants for a data acquisition and testing system (DTS). Each class encapsulates table names and field enumerations for specific domain entities, enabling type-safe field references throughout the codebase. The classes act as schema metadata containers rather than data models, providing a centralized definition of table and column identifiers used in database operations.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### MMEPossibleChannels
|
||||
**Namespace:** `DTS.Storage`
|
||||
```csharp
|
||||
public abstract class MMEPossibleChannels
|
||||
```
|
||||
- `const string Table` — Value: `"tblMMEPossibleChannels"`. Defines the table name for MME possible channels.
|
||||
|
||||
---
|
||||
|
||||
### DbVersions
|
||||
**Namespace:** `Storage.Classes.Abstract`
|
||||
```csharp
|
||||
public abstract class DbVersions
|
||||
```
|
||||
- `enum DbVersionFields` — Fields: `Version`, `Step`, `Date`, `Remarks`, `UserField`.
|
||||
|
||||
---
|
||||
|
||||
### Settings
|
||||
**Namespace:** `DTS.Storage`
|
||||
```csharp
|
||||
public abstract class Settings
|
||||
```
|
||||
- `const string Table` — Value: `"tblSettings"`.
|
||||
- `enum UserFields` — Fields: `PropertyId`, `PropertyType`, `PropertyValue`, `UserId`.
|
||||
|
||||
---
|
||||
|
||||
### VersionTable
|
||||
**Namespace:** `DTS.Storage`
|
||||
```csharp
|
||||
public abstract class VersionTable
|
||||
```
|
||||
- `const string TableName` — Value: `"tblDataPRODbVersion"`.
|
||||
- `enum Fields` — Fields: `Version`, `Step`, `Date`, `Remarks`, `UserField`.
|
||||
|
||||
---
|
||||
|
||||
### TestObjectChannelSettings
|
||||
**Namespace:** `DTS.Storage`
|
||||
```csharp
|
||||
public abstract class TestObjectChannelSettings
|
||||
```
|
||||
- `const string TableName` — Value: `"tblTestObjectChannelSettings"`.
|
||||
- `enum Fields` — Fields: `TestObjectSerial`, `ChannelId`, `Setting`, `SensorSerial`.
|
||||
|
||||
---
|
||||
|
||||
### Tags
|
||||
**Namespace:** `DTS.Storage`
|
||||
```csharp
|
||||
public abstract class Tags
|
||||
```
|
||||
- `const string Table` — Value: `"tblTags"`.
|
||||
- `enum TagFields` — Fields: `TagId`, `TagText`, `Obsolete`.
|
||||
- `const string TAGASSIGNMENTS_TABLE` — Value: `"TagAssignments"`.
|
||||
- `enum TagAssignmentFields` — Fields: `ObjectID`, `ObjectType`, `TagID`.
|
||||
|
||||
---
|
||||
|
||||
### DigitalOutputSettings
|
||||
**Namespace:** `DTS.Storage`
|
||||
```csharp
|
||||
public abstract class DigitalOutputSettings
|
||||
```
|
||||
- `const string Table` — Value: `"tblTOMDigitalChannels"`.
|
||||
- `enum Fields` — Fields: `ChannelDescription`, `DelayMS`, `DurationMS`, `OutputMode`, `LimitDuration`, `LastModified`, `LastModifiedBy`, `Version`, `LocalOnly`, `DurationMSFloat`, `UserTags`.
|
||||
|
||||
---
|
||||
|
||||
### LabratoryDetails
|
||||
**Namespace:** `DTS.Storage`
|
||||
```csharp
|
||||
public abstract class LabratoryDetails
|
||||
```
|
||||
- `const string Table` — Value: `"tblLabratoryDetails"`.
|
||||
- `enum LabratoryDetailsFields` — Fields: `Name`, `LabratoryName`, `LabratoryContactName`, `LabratoryContactPhone`, `LabratoryContactFax`, `LabratoryContactEmail`, `LabratoryTestRefNumber`, `LabratoryProjectRefNumber`, `LastModified`, `LastModifiedBy`, `LocalOnly`, `Version`.
|
||||
|
||||
---
|
||||
|
||||
### Squib
|
||||
**Namespace:** `DTS.Storage`
|
||||
```csharp
|
||||
public abstract class Squib
|
||||
```
|
||||
- `const string Table` — Value: `"tblTOMSquibChannels"`.
|
||||
- `enum Fields
|
||||
40
docs/ai/Common/DTS.Common.Storage/Classes/Static.md
Normal file
40
docs/ai/Common/DTS.Common.Storage/Classes/Static.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.Common.Storage/Classes/Static/CustomChannelFieldSizeAttribute.cs
|
||||
generated_at: "2026-04-17T16:38:14.601225+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "b80f469f3a04031c"
|
||||
---
|
||||
|
||||
# Documentation: CustomChannelFieldSizeAttribute.cs
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module provides a mechanism for associating size metadata with enum values, specifically for the `MMETables.MMEPossibleChannelsFields` enum. It defines a custom attribute `CustomChannelFieldSizeAttribute` to store integer size values, and supplies extension methods for retrieving both this specific attribute and generic attributes from enum values via reflection. This enables declarative configuration of field sizes directly on enum members.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `CustomChannelFieldSizeAttribute` (Class)
|
||||
A custom attribute that stores an integer size value.
|
||||
|
||||
| Member | Signature | Description |
|
||||
|--------|-----------|-------------|
|
||||
| Constructor | `internal CustomChannelFieldSizeAttribute(int size)` | Creates an instance with the specified size. **Note:** Constructor is internal. |
|
||||
| Property | `public int Size { get; private set; }` | Read-only property returning the size value. |
|
||||
|
||||
### `CustomChannelFieldSizeExtensions` (Static Class)
|
||||
Provides extension methods for retrieving field size from enum values.
|
||||
|
||||
| Method | Signature | Description |
|
||||
|--------|-----------|-------------|
|
||||
| `GetFieldSize` | `public static int GetFieldSize(MMETables.MMEPossibleChannelsFields field)` | Retrieves the `Size` value from the `CustomChannelFieldSizeAttribute` applied to the given enum value. |
|
||||
|
||||
### `EnumExtensions` (Static Class)
|
||||
Provides a generic extension method for retrieving attributes from enum values.
|
||||
|
||||
| Method | Signature | Description |
|
||||
|--------|-----------|-------------|
|
||||
| `GetAttribute<TAttribute>` | `public static TAttribute GetAttribute<TAttribute>(this Enum value) where TAttribute : Attribute` | Retrieves a single attribute of type `TAttribute` from the given enum value using
|
||||
Reference in New Issue
Block a user