Files
XplorePlane/XP.Hardware.RaySource/Abstractions/IXRaySource.cs
T

117 lines
3.5 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
using System;
namespace XP.Hardware.RaySource.Abstractions
{
/// <summary>
/// 射线源接口 | X-Ray Source Strategy
/// 定义所有射线源必须实现的核心操作 | Defines core operations required for all X-ray sources
/// </summary>
public interface IXRaySource : IDisposable
{
/// <summary>
/// 是否已连接 | Is connected
/// </summary>
bool IsConnected { get; }
/// <summary>
/// 初始化射线源 | Initialize X-ray source
/// </summary>
XRayResult Initialize();
/// <summary>
/// 连接 PVI 变量并启动实时状态通讯 | Connect PVI variables and start real-time status communication
/// 对应硬件操作流程中的"开启实时状态通讯"步骤 | Corresponds to "start real-time status communication" step in hardware operation flow
/// </summary>
XRayResult ConnectVariables();
/// <summary>
/// 开启射线 | Turn on X-ray
/// </summary>
XRayResult TurnOn();
/// <summary>
/// 关闭射线 | Turn off X-ray
/// </summary>
XRayResult TurnOff();
/// <summary>
/// 完全关闭设备(释放资源)| Fully shut down device (release resources)
/// </summary>
XRayResult CloseOff();
/// <summary>
/// 设置电压(单位:kV| Set voltage (unit: kV)
/// </summary>
/// <param name="voltage">目标电压值 | Target voltage value</param>
XRayResult SetVoltage(float voltage);
/// <summary>
/// 设置电流(单位:μA| Set current (unit: μA)
/// </summary>
/// <param name="current">目标电流值 | Target current value</param>
XRayResult SetCurrent(float current);
/// <summary>
/// 设置焦点(部分设备支持)| Set focus (supported by some devices)
/// </summary>
/// <param name="focus">焦点参数 | Focus parameter</param>
XRayResult SetFocus(float focus);
/// <summary>
/// 读取实际电压值 | Read actual voltage value
/// </summary>
XRayResult ReadVoltage();
/// <summary>
/// 读取实际电流值 | Read actual current value
/// </summary>
XRayResult ReadCurrent();
/// <summary>
/// 读取系统状态 | Read system status
/// </summary>
XRayResult ReadSystemStatus();
/// <summary>
/// 检查错误状态 | Check error status
/// </summary>
XRayResult CheckErrors();
/// <summary>
/// TXI 开启 | TXI On
/// </summary>
XRayResult TxiOn();
/// <summary>
/// TXI 关闭 | TXI Off
/// </summary>
XRayResult TxiOff();
/// <summary>
/// 暖机设置 | Warm-up setting
/// </summary>
XRayResult WarmUp();
/// <summary>
/// 训机设置 | Training setting
/// </summary>
XRayResult Training();
/// <summary>
/// 灯丝校准 | Filament calibration
/// </summary>
XRayResult FilamentCalibration();
/// <summary>
/// 全部电压自动定心 | Auto-center all voltages
/// </summary>
XRayResult AutoCenter();
/// <summary>
/// 设置功率模式 | Set power mode
/// </summary>
/// <param name="mode">功率模式值:1=Micro Focus2=High Power</param>
XRayResult SetPowerMode(int mode);
}
}