#region << 版 本 注 释 >>
/*----------------------------------------------------------------
 * 命名空间：WIDESEAWCS_QuartzJob
 * 创建者：胡童庆
 * 创建时间：2024/8/2 16:13:36
 * 版本：V1.0.0
 * 描述：堆垛机接口层
 *
 * ----------------------------------------------------------------
 * 修改人：
 * 修改时间：
 * 版本：V1.0.1
 * 修改说明：
 * 
 *----------------------------------------------------------------*/
#endregion << 版 本 注 释 >>

using HslCommunication;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WIDESEAWCS_Communicator;
using WIDESEAWCS_Core.Enums;
using WIDESEAWCS_QuartzJob.DeviceBase;
using WIDESEAWCS_QuartzJob.DTO;
using WIDESEAWCS_QuartzJob.StackerCrane;

namespace WIDESEAWCS_QuartzJob
{
    /// <summary>
    /// 堆垛机接口层
    /// </summary>
    public interface IStackerCrane : IDevice
    {
        /// <summary>
        /// 堆垛机通讯对象
        /// </summary>
        BaseCommunicator Communicator { get; }

        /// <summary>
        /// 堆垛机协议信息
        /// </summary>
        List<DeviceProDTO> DeviceProDTOs { get; }

        /// <summary>
        /// 堆垛机协议明细信息
        /// </summary>
        List<DeviceProtocolDetailDTO> DeviceProtocolDetailDTOs { get; }

        /// <summary>
        /// 上一次执行的任务
        /// </summary>
        int LastTaskNum { get; }

        /// <summary>
        /// 当前正在执行的任务
        /// </summary>
        int CurrentTaskNum { get; }

        /// <summary>
        /// 上一次任务类型
        /// </summary>
        int? LastTaskType { get; set; }

        /// <summary>
        /// 与设备的心跳
        /// </summary>
        void Heartbeat();

        /// <summary>
        /// 发送任务命令
        /// </summary>
        /// <param name="command">任务命令</param>
        /// <returns></returns>
        bool SendCommand<T>(T command) where T : IDataTransfer, new();

        /// <summary>
        /// 堆垛机任务完成事件
        /// </summary>
        event EventHandler<StackerCraneTaskCompletedEventArgs> StackerCraneTaskCompletedEventHandler;

        /// <summary>
        /// 读取PLC协议地址的数据
        /// </summary>
        /// <typeparam name="TEnum">协议信息的枚举对象信息。</typeparam>
        /// <typeparam name="TRsult">读取数据的类型对象信息。</typeparam>
        /// <param name="value">枚举值</param>
        /// <returns>读取到的数据</returns>
        TRsult GetValue<TEnum, TRsult>(TEnum value) where TEnum : Enum;

        /// <summary>
        /// 根据参数名称写入堆垛机对应的数据。
        /// </summary>
        /// <typeparam name="TEnum">参数名称枚举类型。</typeparam>
        /// <typeparam name="TValue">要写入的数据类型。</typeparam>
        /// <param name="enum">参数名称。</param>
        /// <param name="value">要写入的数据。</param>
        /// <returns>返回写入成功或失败</returns>
        /// <exception cref="Exception"></exception>
        bool SetValue<TEnum, TValue>(TEnum @enum, TValue value) where TEnum : Enum where TValue : notnull;
    }
}