Sic.Framework-Nanjing-Baishi/MECF.Framework.Common/MECF/Framework/Common/Device/Bases/STEventAction.cs

using System;

namespace MECF.Framework.Common.Device.Bases
{
    /// <summary>
    /// 预设的信号灯塔元件动作。
    /// </summary>
    public class STEventAction : IComparable, ICloneable
    {
        #region Constructors

        /// <summary>
        /// 信号灯塔元件动作构造函数。
        /// </summary>
        /// <param name="name">动作名称。</param>
        /// <param name="light">信号塔组件对象的实例。</param>
        /// <param name="status">信号塔组件输出状态。</param>
        /// <param name="blinkPattern">信号塔组件工作模式。如果传入空值，则自动调用
        /// <see cref="STBlinkPattern.GetDefaultPattern"/>以创建默认工作模式。</param>
        public STEventAction(string name, SignalTowerPartBase light, TowerLightStatus status, STBlinkPattern blinkPattern = null)
        {
            Name = name;
            StPart = light;
            Status = status;
            BlinkPattern = blinkPattern ?? STBlinkPattern.GetDefaultPattern();
        }


        #endregion

        #region Properties

        /// <summary>
        /// 动作名称。
        /// </summary>
        public string Name { get; }

        /// <summary>
        /// 返回信号灯实例。
        /// </summary>
        public SignalTowerPartBase StPart { get; }

        /// <summary>
        /// 设置或返回信号灯的输出状态。
        /// 支持的状态请参考<see cref="TowerLightStatus"/>枚举。
        /// </summary>
        public TowerLightStatus Status { get; set; }
        
        /// <summary>
        /// 设置或返回信号灯闪烁模式。
        /// </summary>
        public STBlinkPattern BlinkPattern { get; set; }

        #endregion

        #region Methods

        /// <inheritdoc />
        public int CompareTo(object obj)
        {
            if (obj is not STEventAction target)
                return -1;

            return (BlinkPattern.CompareTo(target.BlinkPattern) == 0 
                    && Status == target.Status 
                    && StPart == target.StPart) 
                ? 0 
                : -1;
        }
        
        /// <inheritdoc />
        public object Clone()
        {
            return new STEventAction(Name, StPart, Status, (STBlinkPattern)BlinkPattern.Clone());
        }

        /// <inheritdoc/>
        public override string ToString()
        {
            return $"{StPart}, {Status}";    
        }

        #endregion

    }
}