namespace XP.Hardware.MotionControl.Abstractions
{
    /// <summary>
    /// 运动控制操作结果封装类 | Motion Control Operation Result Wrapper
    /// 用于统一返回操作状态和错误信息 | Unified return of operation status and error messages
    /// </summary>
    public class MotionResult
    {
        /// <summary>
        /// 操作是否成功 | Operation success status
        /// </summary>
        public bool Success { get; set; }

        /// <summary>
        /// 错误消息（成功时为null）| Error message (null when successful)
        /// </summary>
        public string ErrorMessage { get; set; }

        /// <summary>
        /// 创建成功结果 | Create success result
        /// </summary>
        /// <param name="message">可选的附加消息 | Optional additional message</param>
        /// <returns>成功结果对象 | Success result object</returns>
        public static MotionResult Ok(string message = null) =>
            new MotionResult { Success = true, ErrorMessage = message };

        /// <summary>
        /// 创建失败结果 | Create failure result
        /// </summary>
        /// <param name="message">错误消息 | Error message</param>
        /// <returns>失败结果对象 | Failure result object</returns>
        public static MotionResult Fail(string message) =>
            new MotionResult { Success = false, ErrorMessage = message };
    }
}