TaskInterfaces.cs

Go to the documentation of this file.

using System.Collections.Generic;
using System.Runtime.InteropServices;
using System;
using System.Collections;
using System.Linq;
using System.Windows.Forms.VisualStyles;
using System.Windows.Media;
using AxelSemrau.Chronos.Plugin.Columns;
 
// ReSharper disable InconsistentNaming
 
namespace AxelSemrau.Chronos.Plugin
{
    [Guid("762DF08B-F3F5-40E1-A652-B7789184FBD5")]
    public interface ITask
    {
        void PreValidate();
 
        void PostValidate();
 
        void Execute();
 
        string GetTaskAction();
    }
 
    public interface IPluginTaskAdapter : ITask, IPluginAdapter<ITask>
    {
 
    }
 
    [Guid("3C667034-390B-4D9F-B388-EB85260945C9")]
    public interface IDemoAwareTask : ITask
    {
        void DemoExecute();
    }
 
    // ReSharper disable CommentTypo
    public class DefaultUnitAttribute : Attribute
    {
        public string UnitSymbol { get; }
 
        public DefaultUnitAttribute(string unitSymbol)
        {
            UnitSymbol = unitSymbol;
        }
    }
 
    [AttributeUsage(AttributeTargets.Class)]
    public class SuppressPathPrefixAttribute : Attribute
    {
    }
 
    [Guid("BE90190E-7BC8-48DD-81E1-0DDA5E0D7AF1")]
    public interface IAbortableTask : ITask
    {
        // ReSharper disable once UnusedMemberInSuper.Global
        bool Aborted { get; set; }
    }
 
    [Guid("DC894545-E16E-4831-A3F6-E2A2E19D4CFD")]
    public interface ITaskForDevice : ITask
    {
        void SetDevice(IDevice yourDevice);
    }
 
    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Property)]
    // ReSharper disable once ClassWithVirtualMembersNeverInherited.Global
    public class DevicesLimitedAttribute : Attribute
    {
        private readonly Type[] mLimitedTo;
 
        public DevicesLimitedAttribute(params Type[] types)
        {
            mLimitedTo = types;
        }
 
 
        public virtual bool IsOK(Type someDeviceType)
        {
            return mLimitedTo?.Any(someType => someType.IsAssignableFrom(someDeviceType)) ?? false;
        }
    }
 
    [Guid("A1167144-70F6-456F-ACE5-247BB884823F")]
    public interface IAccessProperty
    {
        object BaseObject { get; }
 
        System.Reflection.PropertyInfo PropInfo { get; }
        string FullPath { get; }
    }
 
    [Guid("F2F56703-E5F7-4652-B093-0134D4514D16")]
    public interface ITaskInfo
    {
        int JobNo { get; }
 
        int TaskIndex { get; }
 
        object Task { get; }
 
        IEnumerable<IAccessProperty> PropertyAccessInfos { get; }
        IDevice Autosampler { get; }
        ITask PluginTask { get; }
        int UserVisibleIndex { get; }
        int? RepeatCounter { get; }
        #region Easy access common properties
        bool Enabled { get; set; }
        int StartTime { get; }
        int Runtime { get; }
        #endregion
    }
 
    [Guid("F1D539E5-9612-48C3-852E-F655FA909520")]
    public interface IInspectJob
    {
 
        ITaskInfo CurrentTask { get; }
 
        IEnumerable<ITaskInfo> JobsTasks { get; }
        Guid PlanerID { get; }
 
        int JobNo { get; }
 
       
        IEnumerable<IInspectJob> Previous { get; }
        IEnumerable<IInspectJob> Next { get; }
 
        IMethodInfo MethodInfo { get; }
        
        IEnumerable<ITaskInfo> CompleteSchedule { get; }
    }
 
    public interface IMethodInfo
    {
        string Filename { get; }
        string Name { get; }
        string Description { get; }
        IReadOnlyList<IColumnInfo> Columns { get; }
    }
 
    [Guid("E4851471-E72B-4302-A29C-0CFE7E42259A")]
    public interface IResourceManager
    {
        bool AreAllPositionsFree(string trayName, IDevice sampler);
    }
 
    [Guid("10C465A4-3993-4ECD-B983-8AC73B0E0AA6")]
    public interface IUseResources : ITask
    {
        IResourceManager ResourceManager {set;}
    }
 
    [Guid("C50A0177-21DF-407D-AEA4-B806B8F0BF3E")]
    public interface INeedToInspectOtherTasks : ITask
    {
        IInspectJob JobInspector { set; }
    }
 
    [Guid("93EEA6AD-FDC6-4976-8D28-220A98CF3097")]
    public interface INeedToCheckForJITLinks : ITask
    {
        JITCheckerDelegate JITChecker { set; }
    }
    public delegate bool JITCheckerDelegate(object task, string propertyPath);
 
    [Guid("9E8721BC-8DF4-46D1-BF26-DA7693685072")]
    public interface IGiveARuntimeHint : ITask
    {
        int? CalculatedRuntime { get; }
    }
 
    [Guid("18D63C7A-A8AA-4FEA-9D64-59AEF95103EC")]
    public interface IWantEditorUpdates
    {
        void PropertyEdited(string propName, object propValue);
    }
 
    [AttributeUsage(AttributeTargets.Property)]
    public class InvisibleByDefaultAttribute : Attribute
    {
    }
 
    [AttributeUsage(AttributeTargets.Class)]
    public class ScheduleDiagramColorAttribute : Attribute
    {
        public Color Color { get; }
        public ScheduleDiagramColorAttribute(string myColor)
        {
            var pd = typeof(Colors).GetProperty(myColor);
            Color = (pd?.GetValue(null) as Color?).GetValueOrDefault();
        }
 
        public ScheduleDiagramColorAttribute(byte A, byte R, byte G, byte B)
        {
            Color = Color.FromArgb(A, R, G, B);
        }
    }
 
    [AttributeUsage(AttributeTargets.Class)]
    public class TaskCategoryAttribute : Attribute
    {
        public TaskCategoryAttribute(TaskCategory category, int ranking=0)
        {
            Category = category;
            RankWithinCategory = ranking;
        }
 
        // ReSharper disable once AutoPropertyCanBeMadeGetOnly.Local
        public TaskCategory Category { get; private set; }
        // ReSharper disable once AutoPropertyCanBeMadeGetOnly.Global
        public int RankWithinCategory { get; set; }
    }
 
    [AttributeUsage(AttributeTargets.Class)]
    public abstract class CustomTaskCategoryAttribute : TaskCategoryAttribute
    {
        protected CustomTaskCategoryAttribute(int ranking = 0) : base(TaskCategory.Misc, ranking)
        {
        }
        public abstract string Name { get; }
    }
 
 
    public enum TaskCategory
    {
        SamplePrep = 1,
        Cleaning = 2,
        Injection = 3,
        IO = 4,
        CDS = 5,
        FlowControl = 6,
        SPME = 7,
        Misc = 8,
        PAL3SDK = 9,
        LCMS = 10,
        ITSP = 11,
        ITEX = 12
    }
 
 
    [AttributeUsage(AttributeTargets.Property)]
    public class LinkPropertyAttribute : Attribute
    {
        public LinkPropertyAttribute(string taskPropertyPath)
        {
            var sp=taskPropertyPath.Split('.');
            TaskName = sp[0];
            
            if (sp.Length>1)  PropertyName = sp[1];
        }
 
        public LinkPropertyAttribute(string taskName, string propertyName)
        {
            TaskName = taskName;
            PropertyName = propertyName;
        }
        public string TaskName { get; }
 
        public string PropertyName { get; }
    }
 
    public abstract class StandardValueProviderAttribute : Attribute
    {
        public abstract IEnumerable GetStandardValues(ITask theTask);
    }
 
 
    [AttributeUsage(AttributeTargets.Property)]
    public abstract class FilenameAttribute : RecommendedColumnTypeAttribute
    {
        private TargetMode mMode;
 
        public enum TargetMode
        {
            FileRead,
            FileWrite,
            Folder
        }
 
        public TargetMode Mode
        {
            get => mMode;
            set
            {
                mMode = value;
                switch (value)
                {
                    case TargetMode.FileRead:
                    case TargetMode.FileWrite:
                        InternalColumnTypeName = nameof(BuiltinColumnTypeName.File);
                        break;
                    case TargetMode.Folder:
                        InternalColumnTypeName = nameof(BuiltinColumnTypeName.Folder);
                        break;
                }
            }
        }
 
        public virtual string GetCaption() => string.Empty;
 
        public virtual string GetFilenamePattern() => string.Empty;
 
        public virtual string GetInitialValue(ITask theTask) => string.Empty;
 
        protected FilenameAttribute() : base(BuiltinColumnTypeName.File)
        {
        }
    }
 
    public class SimpleFilenameAttribute : FilenameAttribute
    {
        public string Caption { get; set; }
        public string FilenamePattern { get; set; }
        public string InitialValue { get; set; }
 
        public override string GetCaption() => Caption;
        public override string GetFilenamePattern() => FilenamePattern;
 
        public override string GetInitialValue(ITask theTask) => InitialValue;
    }
 
 
 
}