From 9ffd50c8ed26e0be4ccdb500f261132c19600e96 Mon Sep 17 00:00:00 2001
From: hutongqing <hutongqing@hnkhzn.com>
Date: 星期二, 03 九月 2024 15:34:59 +0800
Subject: [PATCH] 增加注释
---
WIDESEAWCS_Server/WIDESEAWCS_QuartzJob/ConveyorLine/CommonConveyorLine.cs | 65 ++++++++++++++++++++++++++++++++
1 files changed, 65 insertions(+), 0 deletions(-)
diff --git a/WIDESEAWCS_Server/WIDESEAWCS_QuartzJob/ConveyorLine/CommonConveyorLine.cs b/WIDESEAWCS_Server/WIDESEAWCS_QuartzJob/ConveyorLine/CommonConveyorLine.cs
index 0ed332f..7aa2adf 100644
--- a/WIDESEAWCS_Server/WIDESEAWCS_QuartzJob/ConveyorLine/CommonConveyorLine.cs
+++ b/WIDESEAWCS_Server/WIDESEAWCS_QuartzJob/ConveyorLine/CommonConveyorLine.cs
@@ -65,20 +65,44 @@
#endregion
#region Public Member
+ /// <summary>
+ /// 杈撻�佺嚎閫氳瀵硅薄
+ /// </summary>
public BaseCommunicator Communicator => _communicator;
+ /// <summary>
+ /// 杈撻�佺嚎鍗忚淇℃伅
+ /// </summary>
public List<DeviceProDTO> DeviceProDTOs => _deviceProDTOs;
+ /// <summary>
+ /// 杈撻�佺嚎鍗忚鏄庣粏淇℃伅
+ /// </summary>
public List<DeviceProtocolDetailDTO> DeviceProtocolDetailDTOs => _deviceProtocolDetailDTOs;
+ /// <summary>
+ /// 璁惧缂栧彿
+ /// </summary>
public string DeviceCode => _deviceCode;
+ /// <summary>
+ /// 璁惧鍚嶇О
+ /// </summary>
public string DeviceName => _deviceName;
+ /// <summary>
+ /// 鏄惁鏈夋晠闅�
+ /// </summary>
public bool IsFault => false;
+ /// <summary>
+ /// 閫氳鏄惁宸茶繛鎺�
+ /// </summary>
public bool IsConnected => Communicator.IsConnected && _isConnected;
+ /// <summary>
+ /// 璁惧鐘舵��
+ /// </summary>
public DeviceStatus Status => DeviceStatus.Offline;
#endregion
@@ -129,6 +153,14 @@
#endregion
#region Public Method
+ /// <summary>
+ /// 璇诲彇PLC鍗忚鍦板潃鐨勬暟鎹�
+ /// </summary>
+ /// <typeparam name="TEnum">鍗忚淇℃伅鐨勬灇涓惧璞′俊鎭��</typeparam>
+ /// <typeparam name="TRsult">璇诲彇鏁版嵁鐨勭被鍨嬪璞′俊鎭��</typeparam>
+ /// <param name="value">鏋氫妇鍊�</param>
+ /// <param name="deviceChildCode">璁惧瀛愮紪鍙�</param>
+ /// <returns>璇诲彇鍒扮殑鏁版嵁</returns>
public TRsult GetValue<TEnum, TRsult>(TEnum value, string deviceChildCode) where TEnum : Enum
{
if (!IsConnected) throw new Exception($"閫氳杩炴帴閿欒锛岃妫�鏌ョ綉缁�");
@@ -136,11 +168,22 @@
return devicePro == null ? throw new Exception() : (TRsult)Communicator.ReadAsObj(devicePro.DeviceProAddress, devicePro.DeviceDataType);
}
+ /// <summary>
+ /// 涓庤澶囩殑蹇冭烦
+ /// </summary>
public void Heartbeat()
{
throw new NotImplementedException();
}
+ /// <summary>
+ ///
+ /// </summary>
+ /// <typeparam name="T"></typeparam>
+ /// <param name="command"></param>
+ /// <param name="deviceChildCode"></param>
+ /// <returns></returns>
+ /// <exception cref="Exception"></exception>
public bool SendCommand<T>(T command, string deviceChildCode) where T : IDataTransfer, new()
{
if (!IsConnected) throw new Exception($"閫氳杩炴帴閿欒锛岃妫�鏌ョ綉缁�");
@@ -156,6 +199,13 @@
return false;
}
+ /// <summary>
+ /// 璇诲彇PLC鏁版嵁锛岃繑鍥炶嚜瀹氫箟瀵硅薄
+ /// </summary>
+ /// <typeparam name="T">娉涘瀷</typeparam>
+ /// <param name="deviceChildCode">瀛愯澶囩紪鍙�</param>
+ /// <returns>杩斿洖鑷畾涔夊璞℃垨鎶涘嚭寮傚父</returns>
+ /// <exception cref="Exception"></exception>
public T ReadCustomer<T>(string deviceChildCode) where T : IDataTransfer, new()
{
if (!IsConnected) throw new Exception($"閫氳杩炴帴閿欒锛岃妫�鏌ョ綉缁�");
@@ -171,6 +221,15 @@
}
}
+ /// <summary>
+ /// 鏍规嵁鍙傛暟鍚嶇О銆佽澶囧瓙缂栧彿鍐欏叆瀵瑰簲鐨勬暟鎹��
+ /// </summary>
+ /// <typeparam name="TEnum">鍙傛暟鍚嶇О鏋氫妇绫诲瀷銆�</typeparam>
+ /// <typeparam name="TValue">瑕佸啓鍏ョ殑鏁版嵁绫诲瀷銆�</typeparam>
+ /// <param name="enum">鍙傛暟鍚嶇О銆�</param>
+ /// <param name="value">瑕佸啓鍏ョ殑鏁版嵁銆�</param>
+ /// <param name="deviceChildCode">璁惧瀛愮紪鍙峰啓</param>
+ /// <returns>杩斿洖鍐欏叆鎴愬姛鎴栧け璐�</returns>
public bool SetValue<TEnum, TValue>(TEnum @enum, TValue value, string deviceChildCode)
where TEnum : Enum
where TValue : notnull
@@ -180,6 +239,12 @@
return devicePro == null ? throw new Exception() : Communicator.WriteObj(devicePro.DeviceProAddress, devicePro.DeviceDataType, value);
}
+ /// <summary>
+ ///
+ /// </summary>
+ /// <param name="deviceChildCode"></param>
+ /// <returns></returns>
+ /// <exception cref="Exception"></exception>
public bool IsOccupied(string deviceChildCode)
{
if (Communicator.IsConnected)
--
Gitblit v1.9.3