noisedestroyers/DP44

Fork 0

Files

noisedestroyers bc3ac1d4c9 init

2026-04-17 14:55:32 -04:00

11 KiB

Raw Permalink Blame History

source_files, generated_at, model, schema_version, sha256

source_files

generated_at

model

schema_version

sha256

DataPRO/Users/ChallengeDialog.cs

DataPRO/Users/IUIItems.cs

DataPRO/Users/UIItemHelper.cs

DataPRO/Users/ChallengeDialog.designer.cs

DataPRO/Users/ITagAware.cs

DataPRO/Users/Tags.cs

DataPRO/Users/UserCollection.cs

2026-04-17T15:49:59.567576+00:00

zai-org/GLM-5-FP8

ff967d41cf0dfb7b

Documentation: DTS.Slice.Users Module

1. Purpose

This module provides user management infrastructure for the DTS.Slice application, including authentication challenges, permission/visibility control for UI items, tag-based entity categorization, and user collection persistence. It handles the interaction between in-memory user objects, UI permission settings, and database storage, supporting both default role-based users and custom user configurations with tag-based access control.

2. Public Interface

ChallengeDialog (Form)

A Windows Forms dialog prompting for administrator password when elevated privileges are required.

Constructor:

ChallengeDialog() - Initializes the dialog component.

UI Controls (publicly accessible):

tbPassword - TextBox with PasswordChar = '*' and UseSystemPasswordChar = true
lblLoginFailedMessage - Label displaying login failure messages (DarkRed foreground)
btnContinue - Button to submit password
btnCancel - Button to cancel the operation
label2 - Instructional label explaining admin access requirement

IUIItems (Interface)

Defines the contract for UI items that support role-based permission and visibility settings.

Method	Return Type	Description
`GetDefaultRolePermission(User.DefaultRoles role)`	`User.UserPermissionLevels`	Gets the default permission level for a given role.
`GetDefaultRoleVisibility(User.DefaultRoles role)`	`bool`	Gets the default visibility for a given role.
`SetVisible(bool bShow)`	`void`	Sets the visibility state.
`SetEnabled(bool bEnabled)`	`void`	Sets the enabled state.
`GetRequiredPermission()`	`User.UserPermissionLevels`	Gets the required permission level.
`GetName()`	`string`	Gets the UI item name.
`GetID()`	`long`	Gets the UI item ID.
`SetID(long id)`	`void`	Sets the UI item ID.

UIItemHelper (Class)

A data container class for UI item settings.

Constructor:

UIItemHelper(long uiItemId, short permission, bool visible, string uiItemName)

Properties:

Property	Type	Access
`UIItemId`	`long`	get; private set;
`UIItemName`	`string`	get; private set;
`IsVisible`	`bool`	get; private set;
`Permission`	`short`	get; private set;

TagAwareBase (Abstract Class)

Abstract base class providing tag management functionality for entities that support tagging.

Enum: TagTypes

User, Group, Template, TestSetup, Sensors, SensorModels

Abstract Property:

TagTypes TagType { get; } - Must be implemented by derived classes.

Properties:

Property	Type	Description
`TagsBlobBytes`	`byte[]`	Gets/sets tags as a serialized byte array (4 bytes per int).
`TagIDs`	`int[]`	Gets/sets the array of tag IDs. Never null; defaults to empty array.

Methods:

Method	Signature	Description
`SetTagsFromCommaSeparatedString`	`void SetTagsFromCommaSeparatedString(string tagText)`	Parses comma-separated tags and sets them.
`SetTags`	`virtual void SetTags(string[] tagsText)`	Sets tags from string array; notifies property change.
`GetTagsAsCommaSeparatedString`	`string GetTagsAsCommaSeparatedString()`	Returns tags as comma-separated string.
`GetTagsArray`	`virtual string[] GetTagsArray()`	Returns tag text array from IDs.
`GetTagIDs`	`virtual int[] GetTagIDs()`	Returns the TagIDs array.
`RemoveTags`	`virtual void RemoveTags(string[] tagsText)`	Removes specified tags.
`TagCompatible`	`bool TagCompatible(string tags)`	Checks if any comma-separated tag matches.
`TagCompatible`	`virtual bool TagCompatible(int[] tags)`	Checks if any tag ID intersects.
`HasIntersectingTag`	`virtual bool HasIntersectingTag(int[] tags)`	Returns true if any tag ID is in TagIDs.
`InsertTagsFromCommaSeparatedString`	`void InsertTagsFromCommaSeparatedString(int id, TagTypes tagType, string tags)`	Sets tags and commits to database.
`Commit`	`void Commit(int id, TagTypes tagType)`	Persists tag assignments to database.
`GetTagIdList`	`List<int> GetTagIdList(int objectId, TagTypes tagType)`	Retrieves tag IDs for an object from database.

Tags (Class)

Singleton class managing tag definitions with in-memory caching.

Nested Class: Tag

Member	Type/Signature	Description
`INVALID_ID`	`const int = -1`	Constant for invalid tag ID.
`ID`	`int`	Tag identifier.
`Text`	`string`	Tag display text.
`IsObsolete`	`bool`	Obsolescence flag.
`Tag(string tagText, int tagId)`	Constructor	Creates tag with text and ID.
`Tag(Tag copy)`	Constructor	Copy constructor.
`Tag(IDataRecord reader)`	Constructor	Constructs from data reader.
`Tag(DataRow dr)`	Constructor	Constructs from data row.
`Clone()`	`object`	ICloneable implementation.

Static Property:

TagsInstance - Singleton instance (lazy-initialized).

Static Methods:

Method	Return Type	Description
`AddTag(string tagText)`	`bool`	Adds tag to DB if not in cache; returns false if already exists or null/empty.
`MigrateTag(string tagText)`	`bool`	Adds tag during migration (commits even if exists).
`AddRange(string[] tagText)`	`bool[]`	Adds multiple tags with start-trimming; returns null if input is null/empty.
`GetIDFromTagText(string tagText)`	`int`	Gets tag ID from database by text.
`GetIDsFromTagText(string[] tagText)`	`int[]`	Gets array of IDs for tag texts; filters out INVALID_ID.
`GetTagTextFromID(int tagID)`	`string`	Gets tag text from cache by ID; returns null if invalid/not found.
`GetTagTextFromIDs(int[] tagId)`	`string[]`	Gets tag texts for IDs; skips invalid/null results.

Instance Methods:

Method	Signature	Description
`ContainsTag`	`bool ContainsTag(string text)`	Checks if tag text exists in cache.
`UpdateList`	`void UpdateList()`	Refreshes cache from database.

UserCollection (Class)

Singleton managing user persistence and retrieval with thread-safe access.

Event:

PropertyChanged - Implements INotifyPropertyChanged.