MiscInterfaces.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Threading.Tasks;
// ReSharper disable InconsistentNaming
 
namespace AxelSemrau.Chronos.Plugin
{
    [Guid("E354519C-F138-4C2E-85CA-122D58C2F424")]
    public interface IHaveRunlogOutput
    {
        event Action<string> WriteToRunlog;
    }
 
    [Guid("1FDD6279-95C7-4AD2-8B9C-B5C3998C3B40")]
    public interface IReactOnCultureChanges
    {
        void UICultureChanged(System.Globalization.CultureInfo newCulture);
    }
 
    public class TraceWriteEventArgs : EventArgs
    {
        public virtual string TextToWrite { get; }
 
        public TraceWriteEventArgs(string someText)
        {
            TextToWrite = someText;
        }
    }
 
    [Guid("E3B9ECED-7495-4151-9E00-7268749F5DD3")]
    public interface ITraceLogger
    {
        event EventHandler<TraceWriteEventArgs> TraceWrite;
    }
 
    #region Schedule state awareness
 
    public enum ScheduleState
    {
        Validated,
        Starting,
 
        Ended,
        SamplersStopped
    }
 
    public abstract class ScheduleStateEventArgs : EventArgs
    {
        public abstract ScheduleState State { get; }
 
        public abstract Guid PlanerID { get; }
 
        public abstract string PlanerName { get; }
        public abstract string AbortReason { get; }
    }
 
    public interface IScheduleEvents
    {
        event EventHandler<ScheduleStateEventArgs> ScheduleStateChanged;
    }
 
    public interface IScheduleStateAware
    {
        IScheduleEvents ScheduleEvents { set; }
    }
 
    #endregion
 
    #region Embedding of methods
 
    public class MethodLaunchEventArgs : EventArgs
    {
        public string Method { get; set; }
    }
 
    public interface IEmbedMethods
    {
        Func<MethodLaunchEventArgs, Task> CreatePlanerFromMethod { set; }
    }
 
    #endregion
 
    [AttributeUsage(AttributeTargets.Property|AttributeTargets.Method)]
    public class DynamicPropertyMasterAttribute : Attribute
    {
    }
 
    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)]
    public class SortPriorityAttribute : Attribute
    {
        public int Priority { get; }
        public SortPriorityAttribute(int pri)
        {
            Priority = pri;
        }
    }
 
    [AttributeUsage(AttributeTargets.Assembly)]
    public abstract class LicenseCheckerAttribute : Attribute
    {
        public abstract string CheckLicense();
    }
 
    public class RequiresAdvancedAttribute : Attribute
    { }
 
    [AttributeUsage(AttributeTargets.Class)]
    public class NoPluginAttribute : Attribute
    {
    }
 
    public interface IProvideDiagnosticLogs
    {
        IEnumerable<string> LogPaths { get; }
    }
 
    public interface IStopRuns
    {
        Func<StopRunArgs, Task> StopRun { set; }
    }
 
    public interface IPluginAdapter<out TPluginInterface> where TPluginInterface : class
    {
        TPluginInterface Plugin { get; }
    }
 
    public class StopRunArgs
    {
        public enum StopMode
        {
            Immediately,
            NoNewJobs
        }
 
        public StopMode How { get; set; }
        public bool RestartRemainingJobs { get; set; }
        public bool StopQueue { get; set; }
        public string Reason { get; set; }
        public bool RunErrorMethod { get; set; }
    }
 
    public interface IColumnInfo
    {
        string Name { get; }
        string Token { get; }
        IReadOnlyList<string> StandardItems { get; }
        string StandardValue { get; }
    }
 
    public interface ILoadPathExtender
    {
        public void AddPath(string folderForAssemblies);
 
        public void ForbidRedirection(string assemblyBaseName);
    }
}