增加注释

hutongqing

2024-09-03 9ffd50c8ed26e0be4ccdb500f261132c19600e96

 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)