76 lines
4.1 KiB
Markdown
76 lines
4.1 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common.DASResource/Settings.Designer.cs
|
||
|
|
generated_at: "2026-04-16T14:08:00.142864+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "944279911ea3f393"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: DTS.Common.DASResource.Settings
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module is an auto-generated strongly-typed settings class created by Visual Studio's Settings Designer (`SettingsSingleFileGenerator`). It provides a singleton access point for application and user-scoped configuration values within the `DTS.Common.DASResource` namespace. The class persists settings via the .NET configuration system and is intended to be extended through the Visual Studio settings designer UI rather than through direct code modification.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### Class: `Settings`
|
||
|
|
**Signature:** `public sealed partial class Settings : global::System.Configuration.ApplicationSettingsBase`
|
||
|
|
|
||
|
|
A singleton class providing strongly-typed access to configuration settings. Instances should not be created directly; use the `Default` property.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### Property: `Default`
|
||
|
|
**Signature:** `public static Settings Default { get; }`
|
||
|
|
|
||
|
|
Returns the synchronized singleton instance of the `Settings` class. This is the primary entry point for accessing all settings values.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### Property: `Samplerate2AAFrequency`
|
||
|
|
**Signature:** `public global::System.Collections.Specialized.OrderedDictionary Samplerate2AAFrequency { get; set; }`
|
||
|
|
|
||
|
|
A user-scoped setting that stores a mapping between sample rates and anti-aliasing (AA) frequencies. Returns an `OrderedDictionary`, suggesting key-value pairs where insertion order matters. The underlying storage is accessed via the indexer key `"Samplerate2AAFrequency"`.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### Property: `abcd`
|
||
|
|
**Signature:** `public string abcd { get; set; }`
|
||
|
|
|
||
|
|
A user-scoped string setting with a default value of `"hdsa askjhsad kjhsad"`. The property name and default value appear to be placeholder/test data. Marked with `DefaultSettingValueAttribute`.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 3. Invariants
|
||
|
|
|
||
|
|
- **Singleton Pattern:** The `defaultInstance` field is created once via `ApplicationSettingsBase.Synchronized()` and returned for all accesses to `Settings.Default`.
|
||
|
|
- **Thread Safety:** The singleton instance is created through `Synchronized()`, which provides thread-safe access per .NET's `ApplicationSettingsBase` contract.
|
||
|
|
- **Auto-generation:** The file is marked with `CompilerGeneratedAttribute` and `GeneratedCodeAttribute`. Manual modifications will be overwritten when the settings are regenerated.
|
||
|
|
- **User-Scoped Persistence:** Both properties are marked with `UserScopedSettingAttribute`, meaning values are stored per-user and can be modified at runtime without affecting other users.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 4. Dependencies
|
||
|
|
|
||
|
|
### This module depends on:
|
||
|
|
- `System.Configuration.ApplicationSettingsBase` — Base class providing settings persistence and synchronization
|
||
|
|
- `System.Collections.Specialized.OrderedDictionary` — Return type for `Samplerate2AAFrequency`
|
||
|
|
- `System.Runtime.CompilerServices.CompilerGeneratedAttribute`
|
||
|
|
- `System.CodeDom.Compiler.GeneratedCodeAttribute`
|
||
|
|
- `System.Diagnostics.DebuggerNonUserCodeAttribute`
|
||
|
|
|
||
|
|
### What depends on this module:
|
||
|
|
**Cannot be determined from source alone.** Consumers would access `Settings.Default` from within the `DTS.Common.DASResource` namespace or externally if the class is publicly accessible.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 5. Gotchas
|
||
|
|
|
||
|
|
- **Placeholder Data:** The `abcd` property has a nonsensical default value (`"hdsa askjhsad kjhsad"`) and a non-descriptive name. This appears to be test/placeholder data that may not have been cleaned up before commit.
|
||
|
|
- **Do Not Edit Directly:** The file header explicitly warns that changes will be lost on regeneration. Settings should be modified through the Visual Studio Settings Designer (`.settings` file) or the `app.config`/`user.config` files at runtime.
|
||
|
|
- **OrderedDictionary Type:** The `Samplerate2AAFrequency` property uses `OrderedDictionary`, which is not generic. Consumers must cast values when retrieving from this dictionary.
|
||
|
|
- **Naming Inconsistency:** The property `Samplerate2AAFrequency` uses PascalCase, while `abcd` uses lowercase, suggesting inconsistent naming conventions or different authors/timing of addition.
|