#region << 版 本 注 释 >>
/*----------------------------------------------------------------
 * 命名空间：WIDESEAWCS_Communicator
 * 创建者：胡童庆
 * 创建时间：2024/8/2 16:13:36
 * 版本：V1.0.0
 * 描述：基础通讯抽象类，封装连接、断开连接、读取、写入等方法
 *
 * ----------------------------------------------------------------
 * 修改人：
 * 修改时间：
 * 版本：V1.0.1
 * 修改说明：
 * 
 *----------------------------------------------------------------*/
#endregion << 版 本 注 释 >>

using HslCommunication;
using HslCommunication.LogNet;
using System.Diagnostics.CodeAnalysis;

namespace WIDESEAWCS_Communicator
{
    public abstract class BaseCommunicator: IDisposable
    {
        /// <summary>
        /// 构造函数
        /// </summary>
        protected BaseCommunicator()
        {
        }

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

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

        /// <summary>  
        /// 获取当前通讯器是否已连接到PLC。  
        /// </summary>
        public abstract bool IsConnected { get; }

        /// <summary>  
        /// 连接到PLC。
        /// </summary>  
        /// <returns>如果连接成功则返回true，否则返回false。</returns>  
        public abstract bool Connect();

        /// <summary>  
        /// 断开与工业设备的连接。  
        /// </summary>  
        /// <returns>如果成功断开连接则返回true，如果已经是断开状态则返回false。</returns>  
        public abstract bool Disconnect();

        /// <summary>  
        /// 从PLC读取数据。  
        /// </summary>  
        /// <param name="address">源地址，具体格式取决于使用的工业协议。</param>  
        /// <param name="length">要读取的数据长度。</param>  
        /// <returns>读取到的数据，如果读取失败则可能返回null或空数组。</returns>  
        public abstract byte[] Read(string address, int length);

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

        /// <summary>
        /// 从PLC读取数据。
        /// </summary>
        /// <param name="address">源地址，具体格式取决于使用的工业协议。</param>
        /// <param name="dataType">数据类型。</param>
        /// <returns>读取到的数据，如果读取失败则可能返回null或抛出异常。</returns>
        public abstract object ReadAsObj(string address, string dataType);

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

        /// <summary>
        /// 向PLC写入数据。
        /// </summary>
        /// <param name="address">源地址，具体格式取决于使用的工业协议。</param>
        /// <param name="dataType">要写入的数据类型。</param>
        /// <param name="value">要写入的数据。</param>
        /// <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();
    }
}