DeviceInterfaces.cs

Go to the documentation of this file.

using System;
using System.Runtime.InteropServices;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Ctc.Palplus.Integration.Driver;
using Ctc.Palplus.Integration.Driver.Entities;
 
namespace AxelSemrau.Chronos.Plugin
{
    public enum ConnectionState
    {
        Disconnected,
 
        Connecting,
 
        Connected,
 
        Disconnecting,
 
        Failed
    }
 
    [Guid("831BEA86-1D89-4761-A481-0F20443F7579")]
    public interface IDevice
    {
        string DisplayedTypeName
        {
            get;
        }
 
        string DeviceTypeDescription
        {
            get;
        }
 
        string Name
        {
            get;
            set;
        }
 
        void Connect();
 
        void Disconnect();
 
        event Action<ConnectionState> ConnectionStateChanged;
    }
 
    public static class DeviceExtensions
    {
        public static string LongID(this IDevice dev) => $"{dev.DeviceTypeDescription} \"{dev.Name}\"";
    }
 
    public class TrayGeometry
    {
        public int Rows { get; protected set; }
        public int Cols { get; protected set; }
 
        public bool IndexingDirectionX { get; protected set; }
 
        public (Quantity x, Quantity y, Quantity z) Size { get; protected set; }
 
        public (Quantity x, Quantity y, Quantity z) FirstSampleOffset { get; protected set; }
 
        public (Quantity x, Quantity y, Quantity z) AlternateSampleOffset { get; protected set; }
 
        public Quantity CavityDiameter { get; protected set; }
 
        public Quantity TotalRowLengthY { get; protected set; }
        public Quantity TotalColLengthX { get; protected set; }
 
 
        public TrayGeometry(int rows, int cols)
        {
            Rows = rows;
            Cols = cols;
            IndexingDirectionX = true;
        }
 
        protected TrayGeometry()
        {
        }
    }
 
    public interface IProvideTrayGeometry : IDevice
    {
        TrayGeometry GetGeometry(string trayName);
    }
 
 
    [Guid("F1226971-CCEB-4AD0-9BF6-22D44AED58E9")]
    public interface INeedAConnection : IDevice
    {
        string Connection
        {
            get;
            set;
        }
    }
    [Guid("8589E2C5-32DD-43EF-9EEB-186530592E27")]
    public interface IManageConnectionState : IDevice
    {
        ConnectionState ConnectionState { get; }
    }
 
    [Guid("7512BE09-4CCD-4FDF-A7CB-2A21630B7A47")]
    public interface IProvideStatusMessages : IDevice
    {
        event Action<string> SetStatusMessage;
    }
 
    [Guid("E8F8A431-3BFB-481C-9007-A0B5DB229DEC")]
    public interface IHaveDebugOutput : IDevice
    {
        event Action<string> DebugOutput;
    }
 
    [Guid("EB9F2BC9-5C34-4485-8A68-A5890E6F80C6")]
    public interface IAbortSchedules : IDevice
    {
        event Action<string> AbortSchedule;
    }
 
    [Guid("A88FFB64-3605-4FBB-A1BA-951A10686775")]
    public interface IMultipartDevice : IDevice
    {
        IReadOnlyCollection<IDevice> Parts { get; }
    }
 
    public enum ErrorType
    {
        Other,
        BarcodeNotRead,
        MissingVial
    }
 
    public class InteractiveErrorHandlingEventArgs : EventArgs
    {
        public bool RetryLastAction { get; set; } = false;
 
        public string Error { get; set; }
 
        public ErrorType ErrorType { get; set; }
    }
 
    [Guid("EC088A8E-BE61-49CA-84E2-D06DF0167AF6")]
    public interface IHaveInteractiveErrorHandling : IDevice
    {
        void BeginInteraction();
        void EndInteraction();
 
        event EventHandler<InteractiveErrorHandlingEventArgs> HandleError;
    }
 
 
    [Guid("EDDB22B2-82DB-488B-997D-E8369F860AD7")]
    public interface ICanInterrupt : IDevice
    {
        bool Aborted { get; set; }
        bool Paused { get; set; }
    }
 
    [Guid("E990933A-5282-4A43-B64E-7EEFECBE9BF8")]
    public interface IHaveMachineParameters<ParamType> : IDevice where ParamType : class, new()
    {
        ParamType Parameters { set; get; }
 
        Task ApplyParametersAsync(bool waitUntilSetpointIsReached, CancellationToken cancelToken);
    }
 
    [Guid("4915BAD4-53C7-4453-97E8-ECC7C2E52E62")]
    public interface IDirectDeviceAccess
    {
        IEnumerable<IDevice> ConfiguredDevices { set; }
    }
 
    [Guid("4D78A78F-776F-4D0D-ACC0-4A1829429A76")]
    public interface IPal3Options
    {
        bool ResetBeforeSequence { get; set; }
        bool AlwaysResetAfterSequence { get; set; }
    }
 
    [Guid("AFF1F948-EBB3-484D-9EDC-0DD2CA2FDBAA")]
    public interface IPal3Access
    {
        IPal3Options Options { get; }
        IPalPlusConfigurationService ConfigService { get; }
    }
 
    public interface IJobAwareDevice : IDevice
    {
        void JobFinished(int jobNo);
    }
 
    public interface IBarcodeReader : IDevice
    {
        string ReadBarcode();
    }
 
    public interface IPluginDeviceAdapter : IDevice, IPluginAdapter<IDevice>
    {
 
    }
 
}