添加注释

This commit is contained in:
2025-07-03 13:17:25 +08:00
parent 4159e95bf3
commit eaffc6da5c
15 changed files with 686 additions and 392 deletions

View File

@@ -5,28 +5,60 @@ using ProtocolType = PMSWPF.Enums.ProtocolType;
namespace PMSWPF.Data.Entities;
/// <summary>
/// 表示数据库中的设备实体。
/// </summary>
[SugarTable("Device")]
public class DbDevice
{
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增
public int Id { get; set; }
public string Name { get; set; }
/// <summary>
/// 设备的描述信息。
/// </summary>
[SugarColumn(IsNullable = true)]
public string? Description { get; set; }
public string Ip { get; set; }
public bool IsActive { get; set; }
public bool IsRuning { get; set; }
/// <summary>
/// 设备的类型。
/// </summary>
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public DeviceType DeviceType { get; set; }
/// <summary>
/// 设备的唯一标识符。
/// </summary>
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增
public int Id { get; set; }
/// <summary>
/// 设备的IP地址。
/// </summary>
public string Ip { get; set; }
/// <summary>
/// 表示设备是否处于活动状态。
/// </summary>
public bool IsActive { get; set; }
/// <summary>
/// 表示设备是否正在运行。
/// </summary>
public bool IsRuning { get; set; }
/// <summary>
/// 设备的名称。
/// </summary>
public string Name { get; set; }
/// <summary>
/// 设备的通信协议类型。
/// </summary>
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public ProtocolType ProtocolType { get; set; }
/// <summary>
/// 设备关联的变量表列表。
/// </summary>
[Navigate(NavigateType.OneToMany, nameof(DbVariableTable.DeviceId))]
[SugarColumn(IsNullable = true)]
public List<DbVariableTable>? VariableTables { get; set; }
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public ProtocolType ProtocolType { get; set; }
}

View File

@@ -4,22 +4,53 @@ using SqlSugar.DbConvert;
namespace PMSWPF.Data.Entities;
/// <summary>
/// 表示数据库中的菜单实体。
/// </summary>
[SugarTable("Menu")]
public class DbMenu
{
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
public int Id { get; set; }
public string Icon { get; set; }
public string Name { get; set; }
public int ParentId { get; set; }
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public MenuType Type { get; set; }
public int DataId { get; set; }
/// <summary>
/// 菜单项关联的数据。
/// </summary>
[SugarColumn(IsIgnore = true)]
public Object? Data { get; set; }
public object? Data { get; set; }
/// <summary>
/// 菜单项关联的数据ID。
/// </summary>
public int DataId { get; set; }
/// <summary>
/// 菜单项的图标。
/// </summary>
public string Icon { get; set; }
/// <summary>
/// 菜单项的唯一标识符。
/// </summary>
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
public int Id { get; set; }
/// <summary>
/// 子菜单项列表。
/// </summary>
[SugarColumn(IsIgnore = true)]
public List<DbMenu> Items { get; set; }
/// <summary>
/// 菜单项的名称。
/// </summary>
public string Name { get; set; }
/// <summary>
/// 父菜单项的ID。
/// </summary>
public int ParentId { get; set; }
/// <summary>
/// 菜单项的类型。
/// </summary>
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public MenuType Type { get; set; }
}

View File

@@ -4,76 +4,81 @@ using SqlSugar.DbConvert;
namespace PMSWPF.Data.Entities;
/// <summary>
/// 表示数据库中的MQTT配置实体。
/// </summary>
[SugarTable("Mqtt")]
public class DbMqtt
{
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增
public int Id { get; set; }
/// <summary>
/// MQTT客户端ID。
/// </summary>
public string ClientID { get; set; } = String.Empty;
/// <summary>
/// MQTT主机
/// 创建时间。
/// </summary>
public DateTime CreateTime { get; set; } = DateTime.Now;
/// <summary>
/// MQTT主机。
/// </summary>
public string Host { get; set; }
/// <summary>
/// MQTT主机端口
/// MQTT配置的唯一标识符。
/// </summary>
public int Port { get; set; }
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增
public int Id { get; set; }
/// <summary>
/// 是否启用
/// 是否启用此MQTT配置。
/// </summary>
public bool IsActive { get; set; }
/// <summary>
/// Mqtt平台
/// </summary>
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public MqttPlatform Platform { get; set; }
/// <summary>
/// MQTT客户端名字
/// </summary>
public string Name { get; set; }
/// <summary>
/// MQTT客户端登录用户名
/// </summary>
public string UserName { get; set; } = String.Empty;
/// <summary>
/// MQTT客户端登录密码
/// </summary>
public string PassWord { get; set; } = String.Empty;
/// <summary>
/// MQTT客户端ID
/// </summary>
public string ClientID { get; set; }= String.Empty;
/// <summary>
/// MQTT发布主题
/// </summary>
public string PublishTopic { get; set; } = String.Empty;
/// <summary>
/// MQTT订阅主题
/// </summary>
public string SubTopics { get; set; }= String.Empty;
/// <summary>
/// 是否设置为默认MQTT客户端
/// 是否设置为默认MQTT客户端。
/// </summary>
public int IsDefault { get; set; }
/// <summary>
/// 创建时间
/// MQTT客户端名字。
/// </summary>
public DateTime CreateTime { get; set; }= DateTime.Now;
public string Name { get; set; }
/// <summary>
/// MQTT备注
/// MQTT客户端登录密码。
/// </summary>
public string PassWord { get; set; } = String.Empty;
/// <summary>
/// Mqtt平台类型。
/// </summary>
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public MqttPlatform Platform { get; set; }
/// <summary>
/// MQTT主机端口。
/// </summary>
public int Port { get; set; }
/// <summary>
/// MQTT发布主题。
/// </summary>
public string PublishTopic { get; set; } = String.Empty;
/// <summary>
/// MQTT备注。
/// </summary>
public string Remark { get; set; } = String.Empty;
/// <summary>
/// MQTT订阅主题。
/// </summary>
public string SubTopics { get; set; } = String.Empty;
/// <summary>
/// MQTT客户端登录用户名。
/// </summary>
public string UserName { get; set; } = String.Empty;
}

View File

@@ -2,30 +2,62 @@ using SqlSugar;
namespace PMSWPF.Data.Entities;
/// <summary>
/// 表示数据库中的NLog日志实体。
/// </summary>
[SugarTable("nlog")]
public class DbNlog
{
// INSERT INTO [dbo].[NLog] (
// [Application], [Logged], [Level], [ThreadID],[Message],
// [Logger], [Callsite], [Exception], [Url], [Action], [User]
// ) VALUES (
// @Application, @Logged, @Level,@ThreadID, @Message,
// @Logger, @Callsite, @Exception, @Url, @Action, @User
// )
/// <summary>
/// 日志调用位置。
/// </summary>
public string Callsite { get; set; }
/// <summary>
/// 日志调用行号。
/// </summary>
public int CallsiteLineNumber { get; set; }
/// <summary>
/// 异常信息。
/// </summary>
[SugarColumn(IsNullable = true, ColumnDataType = "text")]
public string Exception { get; set; }
/// <summary>
/// 日志的唯一标识符。
/// </summary>
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增
public int Id { get; set; }
public DateTime LogTime { get; set; }
/// <summary>
/// 日志级别。
/// </summary>
public string Level { get; set; }
public int ThreadID { get; set; }
[SugarColumn(IsNullable = true)] public string ThreadName { get; set; }
/// <summary>
/// 日志记录器名称。
/// </summary>
public string Logger { get; set; }
public string Callsite { get; set; }
public int CallsiteLineNumber { get; set; }
/// <summary>
/// 日志时间。
/// </summary>
public DateTime LogTime { get; set; }
/// <summary>
/// 日志消息内容。
/// </summary>
public string Message { get; set; }
[SugarColumn(IsNullable = true, ColumnDataType = "text")]
public string Exception { get; set; }
/// <summary>
/// 线程ID。
/// </summary>
public int ThreadID { get; set; }
/// <summary>
/// 线程名称。
/// </summary>
[SugarColumn(IsNullable = true)]
public string ThreadName { get; set; }
}

View File

@@ -2,9 +2,15 @@
namespace PMSWPF.Data.Entities;
/// <summary>
/// 表示数据库中的用户实体。
/// </summary>
[SugarTable("User")]
public class DbUser
{
/// <summary>
/// 用户的唯一标识符。
/// </summary>
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增
public int Id { get; set; }
}

View File

@@ -4,123 +4,126 @@ using SqlSugar.DbConvert;
namespace PMSWPF.Data.Entities;
/// <summary>
/// 表示数据库中的变量数据实体。
/// </summary>
[SugarTable("VarData")]
public class DbVariableData
{
/// <summary>
/// 变量唯一标识符
/// 报警的最大值阈值。
/// </summary>
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增
public int Id { get; set; }
public double AlarmMax { get; set; }
/// <summary>
/// 关联的变量表ID
/// 报警的最小值阈值。
/// </summary>
public int VariableTableId { get; set; }
public double AlarmMin { get; set; }
/// <summary>
/// 关联的变量表实体
/// 数据转换规则或表达式。
/// </summary>
[Navigate(NavigateType.ManyToOne, nameof(VariableTableId))]
public DbVariableTable? VariableTable { get; set; }
public string Converstion { get; set; } = String.Empty;
/// <summary>
/// 变量名称
/// 数据类型例如Int、Float、String等。
/// </summary>
public string Name { get; set; }
public string DataType { get; set; } = String.Empty;
/// <summary>
/// 变量描述
/// 变量当前原始数据值。
/// </summary>
public string DataValue { get; set; } = String.Empty;
/// <summary>
/// 变量描述。
/// </summary>
[SugarColumn(IsNullable = true)]
public string? Description { get; set; }
/// <summary>
/// 节点ID用于标识变量在设备或系统中的唯一路径
/// </summary>
public string NodeId { get; set; } = String.Empty;
/// <summary>
/// 协议类型例如Modbus、OPC UA等
/// </summary>
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public ProtocolType ProtocolType { get; set; }
/// <summary>
/// 数据类型例如Int、Float、String等
/// </summary>
public string DataType { get; set; }=String.Empty;
/// <summary>
/// 信号类型,例如模拟量、数字量等
/// </summary>
[SugarColumn(ColumnDataType = "varchar(20)", IsNullable = true, SqlParameterDbType = typeof(EnumToStringConvert))]
public SignalType SignalType { get; set; }
/// <summary>
/// 变量当前原始数据值
/// </summary>
public string DataValue { get; set; } = String.Empty;
/// <summary>
/// 变量经过转换或格式化后的显示值
/// 变量经过转换或格式化后的显示值。
/// </summary>
public string DisplayValue { get; set; } = String.Empty;
/// <summary>
/// 变量数据最后更新时间
/// 变量唯一标识符。
/// </summary>
public DateTime UpdateTime { get; set; } = DateTime.Now;
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增
public int Id { get; set; }
/// <summary>
/// 最后更新变量数据的用户
/// 指示是否需要对变量进行报警监测。
/// </summary>
[SugarColumn(IsNullable = true)]
public DbUser? UpdateUser { get; set; }
public bool IsAlarm { get; set; }
/// <summary>
/// 关联的MQTT配置列表
/// 指示变量是否处于激活状态。
/// </summary>
public bool IsActive { get; set; }
/// <summary>
/// 指示变量是否已被逻辑删除。
/// </summary>
public bool IsDeleted { get; set; }
/// <summary>
/// 指示是否需要保存变量数据。
/// </summary>
public bool IsSave { get; set; }
/// <summary>
/// 关联的MQTT配置列表。
/// </summary>
[SugarColumn(IsNullable = true)]
public List<DbMqtt>? Mqtts { get; set; }
/// <summary>
/// 数据转换规则或表达式
/// 变量名称。
/// </summary>
public string Converstion { get; set; } = String.Empty;
public string Name { get; set; }
/// <summary>
/// 指示变量是否处于激活状态
/// 节点ID用于标识变量在设备或系统中的唯一路径。
/// </summary>
public bool IsActive { get; set; }
public string NodeId { get; set; } = String.Empty;
/// <summary>
/// 指示是否需要保存变量数据
/// 协议类型例如Modbus、OPC UA等。
/// </summary>
public bool IsSave { get; set; }
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public ProtocolType ProtocolType { get; set; }
/// <summary>
/// 数据保存的范围或阈值
/// 数据保存的范围或阈值
/// </summary>
public double SaveRange { get; set; }
/// <summary>
/// 指示是否需要对变量进行报警监测
/// 信号类型,例如模拟量、数字量等。
/// </summary>
public bool IsAlarm { get; set; }
[SugarColumn(ColumnDataType = "varchar(20)", IsNullable = true, SqlParameterDbType = typeof(EnumToStringConvert))]
public SignalType SignalType { get; set; }
/// <summary>
/// 报警的最小值阈值
/// 变量数据最后更新时间。
/// </summary>
public double AlarmMin { get; set; }
public DateTime UpdateTime { get; set; } = DateTime.Now;
/// <summary>
/// 报警的最大值阈值
/// 最后更新变量数据的用户。
/// </summary>
public double AlarmMax { get; set; }
[SugarColumn(IsNullable = true)]
public DbUser? UpdateUser { get; set; }
/// <summary>
/// 指示变量是否已被逻辑删除
/// 关联的变量表实体。
/// </summary>
public bool IsDeleted { get; set; }
[Navigate(NavigateType.ManyToOne, nameof(VariableTableId))]
public DbVariableTable? VariableTable { get; set; }
/// <summary>
/// 关联的变量表ID。
/// </summary>
public int VariableTableId { get; set; }
}

View File

@@ -2,6 +2,9 @@
namespace PMSWPF.Data.Entities;
/// <summary>
/// 表示数据库中的S7变量数据实体继承自DbVariableData。
/// </summary>
[SugarTable("S7DataVariable")]
public class DbVariableS7Data : DbVariableData
{

View File

@@ -4,25 +4,55 @@ using SqlSugar.DbConvert;
namespace PMSWPF.Data.Entities;
/// <summary>
/// 表示数据库中的变量表实体。
/// </summary>
[SugarTable("VariableTable")]
public class DbVariableTable
{
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增
public int Id { get; set; }
public string Name { get; set; }
public bool IsActive { get; set; }
[SugarColumn(IsNullable = true)] public string? Description { get; set; }
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public ProtocolType ProtocolType { get; set; }
/// <summary>
/// 变量表中包含的数据变量列表。
/// </summary>
[Navigate(NavigateType.OneToMany, nameof(DbVariableData.VariableTableId))]
public List<DbVariableData>? DataVariables { get; set; }
[SugarColumn(IsNullable = true)] public int? DeviceId { get; set; }
/// <summary>
/// 变量表关联的设备。
/// </summary>
[Navigate(NavigateType.ManyToOne, nameof(DeviceId))]
public DbDevice? Device { get; set; }
/// <summary>
/// 变量表关联的设备ID。
/// </summary>
[SugarColumn(IsNullable = true)]
public int? DeviceId { get; set; }
/// <summary>
/// 变量表描述。
/// </summary>
[SugarColumn(IsNullable = true)]
public string? Description { get; set; }
/// <summary>
/// 变量表的唯一标识符。
/// </summary>
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增
public int Id { get; set; }
/// <summary>
/// 表示变量表是否处于活动状态。
/// </summary>
public bool IsActive { get; set; }
/// <summary>
/// 变量表名称。
/// </summary>
public string Name { get; set; }
/// <summary>
/// 变量表使用的协议类型。
/// </summary>
[SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
public ProtocolType ProtocolType { get; set; }
}