增加注释

hutongqing

2024-09-03 9ffd50c8ed26e0be4ccdb500f261132c19600e96

 WIDESEAWCS_Server/WIDESEAWCS_Communicator/BaseCommunicator.cs

@@ -21,7 +21,7 @@

namespace WIDESEAWCS_Communicator
{
    public abstract class BaseCommunicator
    public abstract class BaseCommunicator: IDisposable
    {
        /// <summary>
        /// 构造函数
@@ -30,8 +30,14 @@
        {
        }

        /// <summary>
        /// 日志记录实例对象
        /// </summary>
        public abstract ILogNet LogNet { get; }

        /// <summary>
        /// 设备名称
        /// </summary>
        public abstract string Name { get; }

        /// <summary>  
@@ -64,7 +70,6 @@
        /// </summary>
        /// <typeparam name="T">读取数据的类型泛型。</typeparam>
        /// <param name="address">源地址，具体格式取决于使用的工业协议。</param>
        /// <param name="length">要读取的数据长度。</param>
        /// <returns>读取到的数据，如果读取失败则可能返回null或抛出异常。</returns>
        public abstract T Read<T>(string address);

@@ -81,16 +86,16 @@
        /// </summary>  
        /// <param name="address">源地址，具体格式取决于使用的工业协议。</param>  
        /// <param name="data">要写入的数据。</param>  
        /// <returns>如果写入成功则返回true，否则返回false。</returns>  
        /// <returns>如果写入成功则返回true，否则抛出异常。</returns>  
        public abstract bool Write(string address, byte[] data);

        /// <summary>
        /// 
        /// 向PLC写入数据。  
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="address"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        /// <typeparam name="T">读取数据的类型泛型。</typeparam>
        /// <param name="address">源地址，具体格式取决于使用的工业协议。</param>
        /// <param name="value">要写入的数据。</param>
        /// <returns>如果写入成功则返回true，否则抛出异常。</returns>
        public abstract bool Write<T>(string address, T value) where T : notnull;

        /// <summary>
@@ -99,14 +104,41 @@
        /// <param name="address">源地址，具体格式取决于使用的工业协议。</param>
        /// <param name="dataType">要写入的数据类型。</param>
        /// <param name="value">要写入的数据。</param>
        /// <returns>如果写入成功则返回true，失败则抛出自定义通讯异常。</returns>
        /// <returns>如果写入成功则返回true，失败则抛出异常。</returns>
        /// <exception cref="CommunicationException"></exception>
        public abstract bool WriteObj(string address, string dataType, object value);

        /// <summary>
        /// 等待指定地址的泛型类型值为指定的值
        /// </summary>
        /// <typeparam name="T">指定的值的类型泛型。</typeparam>
        /// <param name="address">源地址，具体格式取决于使用的工业协议。</param>
        /// <param name="readInterval">读取的频率。</param>
        /// <param name="waitTimeout">等待的超时时间，如果超时时间为-1的话，则是无期限等待。</param>
        /// <param name="value">等待检测的值</param>
        /// <returns>是否等待成功的结果对象，一旦通信失败，或是等待超时就返回失败。否则返回成功，并告知调用方等待了多久。</returns>
        public abstract OperateResult<TimeSpan> Wait<T>(string address, int readInterval, int waitTimeout, T value) where T : struct;

        /// <summary>
        /// 读取自定义的数据类型，需要继承自IDataTransfer接口，返回一个新的类型的实例对象。
        /// </summary>
        /// <typeparam name="T">自定义的数据类型泛型。</typeparam>
        /// <param name="address">源地址，具体格式取决于使用的工业协议。</param>
        /// <returns>成功返回自定义类型数据，失败抛出异常。</returns>
        public abstract T ReadCustomer<T>(string address) where T : IDataTransfer, new();

        /// <summary>
        /// 写入自定义类型的数据，该类型必须继承自IDataTransfer接口。
        /// </summary>
        /// <typeparam name="T">自定义的数据类型泛型。</typeparam>
        /// <param name="address">源地址，具体格式取决于使用的工业协议。</param>
        /// <param name="value">要写入数据。</param>
        /// <returns>如果写入成功则返回true，失败则抛出异常。</returns>
        public abstract bool WriteCustomer<T>(string address, [NotNull] T value) where T : IDataTransfer, new();

        /// <summary>
        /// 释放对象资源的接口。
        /// </summary>
        public abstract void Dispose();
    }
}