Provides an endless supply of nonsense sample lists. More...

Inheritance diagram for MockPlugin.SampleList.MockSampleListWorker:

Collaboration diagram for MockPlugin.SampleList.MockSampleListWorker:

Public Member Functions
	MockSampleListWorker ()
void	DoYourJob ()
	Take over control. When this function exits, Chronos is in charge again.
void	Dispose ()

Static Public Member Functions
static IEnumerable< string >	GetFakeLogs (string creator)
	Creates a few fake log files.

Protected Member Functions
virtual void	OnPropertyChanged ([CallerMemberName] string propertyName=null)

Properties
string	ButtonCaption = NormalButtonLabel `[get, private set]`
	Shown on the sample list page.
System.Drawing.Icon	ButtonIcon = Properties.Resources.MockNormal `[get, private set]`
	Shown in the button, preferred size 22x22.
ISampleListAccessor	SampleList `[set]`
	Here we get an helper that allows us to manipulate the current sample list.
IEnumerable< IDevice >	ConfiguredDevices `[get, set]`
	List of IDevice for all configured devices in Chronos.
IEnumerable< string >	LogPaths `[get]`
	Provide full paths to each of your log files here.
Func< StopRunArgs, Task >	StopRun `[set]`
	Callback function returning a task that completes once the schedule queue was stopped.

Events
RunSampleListHandler	RunSampleList
PropertyChangedEventHandler	PropertyChanged
Events inherited from AxelSemrau.Chronos.Plugin.INeedToRunSampleLists
RunSampleListHandler	RunSampleList
	Trigger this event to actually create and run a schedule.

Private Member Functions
bool	OneMoreScheduleWanted (Window ownerWin)
	Ask the user if he wants to start more schedules.
void	HandleAbortButton (ShowPluginIsInCharge win)
void	HandleStopButton (ShowPluginIsInCharge win)
void	TurnOffResets ()
void	DoOnGUIThread (Action theAction)
	Execute the specified action in the GUI thread's context.

Private Attributes
readonly TaskFactory	mGuiFactory
Func< StopRunArgs, Task >	mStopRun

Static Private Attributes
const string	NormalButtonLabel = "Run plugin provided\r\nsample lists"

Detailed Description

Provides an endless supply of nonsense sample lists.

A possible serious use would be to generate sample lists from LIMS data and to feed them to Chronos.

Definition at line 30 of file MockSampleListWorker.cs.

Constructor & Destructor Documentation

◆ MockSampleListWorker()

MockPlugin.SampleList.MockSampleListWorker.MockSampleListWorker ( )

Definition at line 40 of file MockSampleListWorker.cs.

        {
            // for GUI synchronized operations
            mGuiFactory = new TaskFactory(Helpers.Gui.GuiThreadScheduler);
            // for the remote access example
            RemotePluginService.StartService();
        }

References AxelSemrau.Chronos.Plugin.Helpers.Gui, AxelSemrau.Chronos.Plugin.IGuiHelper.GuiThreadScheduler, and mGuiFactory.

Member Function Documentation

◆ Dispose()

void MockPlugin.SampleList.MockSampleListWorker.Dispose ( )

Definition at line 218 of file MockSampleListWorker.cs.

        {
            RemotePluginService.StopService();
        }

References MockPlugin.SampleList.RemotePluginService.StopService().

◆ DoOnGUIThread()

void MockPlugin.SampleList.MockSampleListWorker.DoOnGUIThread ( Action theAction )

private

Execute the specified action in the GUI thread's context.

Parameters

theAction

Definition at line 190 of file MockSampleListWorker.cs.

        {
            mGuiFactory.StartNew(theAction).GetAwaiter().GetResult();
        }

References mGuiFactory.

Referenced by DoYourJob(), and OneMoreScheduleWanted().

◆ DoYourJob()

void MockPlugin.SampleList.MockSampleListWorker.DoYourJob ( )

Take over control. When this function exits, Chronos is in charge again.

We show some dialog window to make clear what we are doing, and that we are in charge.

Implements AxelSemrau.Chronos.Plugin.IWorkWithSampleLists.

Definition at line 76 of file MockSampleListWorker.cs.

        {
            // Use the process' main window as owner, so that our blocking
            // window can not be hidden behind the main window.
            ShowPluginIsInCharge win = null;
            ButtonIcon = Properties.Resources.MockBusy;
            ButtonCaption = "Plugin busy";
            OnPropertyChanged(nameof(ButtonIcon));
            OnPropertyChanged(nameof(ButtonCaption));
 
            DoOnGUIThread(() =>
            {
                // checking if it also works when called from the GUI thread
                Core.ExecutionQueue.RemoveFailedPlanners();
                win = new ShowPluginIsInCharge();
                var wih = new WindowInteropHelper(win);
                var winHandle = wih.EnsureHandle();
                HandleAbortButton(win);
                HandleStopButton(win);
                Helpers.Gui.OwnMyWindow(winHandle);
                win.Show();
            });
            try
            {
                do
                {
                    // prevent previously failed planners from stopping us
                    Core.ExecutionQueue.RemoveFailedPlanners();
                    Helpers.Debug.TraceWrite($"Just FYI: Standard sample lists are at {Helpers.Config.PathToSampleLists ?? "(N/A)"} and methods are at {Helpers.Config.PathToMethods ?? "(N/A)"}, the instrument config is at {Helpers.Config.PathToInstrumentConfig}");
                    TurnOffResets();
                    System.Threading.Thread.Sleep(5000);
                    var ex = RunSampleList?.Invoke(this,
                        new RunSampleListEventArgs()
                        {
                            //SampleListFile = @"C:\Users\Patrick\Documents\Chronos\MoveTest.csl"
                            ExtendLastPlanner = false,
                            StartAndWaitForEnd = false,
                            SwitchToSchedulesView = false,
                            RespectSelection = false
                        }
                    );
                    if (ex != null)
                    {
                        System.Windows.Forms.MessageBox.Show(Helpers.Gui.MainWindow,$"Error: {ex.Message}", "Plugin Provided Schedule",System.Windows.Forms.MessageBoxButtons.OK,System.Windows.Forms.MessageBoxIcon.Error);
                    }
                } while (OneMoreScheduleWanted(win));
            }
            finally
            {
                DoOnGUIThread(() => win.Close());
                ButtonIcon = Properties.Resources.MockNormal;
                ButtonCaption = NormalButtonLabel;
                OnPropertyChanged(nameof(ButtonIcon));
                OnPropertyChanged(nameof(ButtonCaption));
            }
        }

References ButtonCaption, ButtonIcon, AxelSemrau.Chronos.Plugin.Helpers.Debug, DoOnGUIThread(), AxelSemrau.Chronos.Core.ExecutionQueue, AxelSemrau.Chronos.Plugin.Helpers.Gui, HandleAbortButton(), HandleStopButton(), AxelSemrau.Chronos.Plugin.IGuiHelper.MainWindow, NormalButtonLabel, OneMoreScheduleWanted(), OnPropertyChanged(), AxelSemrau.Chronos.Plugin.IGuiHelper.OwnMyWindow(), AxelSemrau.Chronos.IScheduleQueue.RemoveFailedPlanners(), RunSampleList, AxelSemrau.Chronos.Plugin.IDebugHelper.TraceWrite(), and TurnOffResets().

◆ GetFakeLogs()

IEnumerable< string > MockPlugin.SampleList.MockSampleListWorker.GetFakeLogs ( string creator )

static

Creates a few fake log files.

Parameters

creator

Returns

Definition at line 237 of file MockSampleListWorker.cs.

        {
            for (var i = 1; i <= 5; ++i)
            {
                var fakePath = System.IO.Path.GetTempFileName();
                System.IO.File.WriteAllText(fakePath, $"Fake log entry in file {i} created at {DateTime.Now:hh:mm:ss} by {creator}");
                yield return fakePath;
            }
        }

◆ HandleAbortButton()

void MockPlugin.SampleList.MockSampleListWorker.HandleAbortButton ( ShowPluginIsInCharge win )

private

Definition at line 133 of file MockSampleListWorker.cs.

        {
            win.AbortButton.Click += (s, e) =>
            {
                // Click handler: This runs on the GUI thread
                win.AbortButton.IsEnabled = false;
                var abortWaiter = mStopRun.Invoke(new StopRunArgs() {How = StopRunArgs.StopMode.Immediately});
                abortWaiter.ContinueWith((t) =>
                {
                    // after the background abort call has finished, continue with enabling the button on the GUI thread.
                    try
                    {
                        win.AbortButton.IsEnabled = true;
                    }
                    catch
                    {
                        // suppress exceptions in case the button does not exist any more
                    }
                }, Helpers.Gui.GuiThreadScheduler);
            };
        }

References AxelSemrau.Chronos.Plugin.Helpers.Gui, AxelSemrau.Chronos.Plugin.IGuiHelper.GuiThreadScheduler, and mStopRun.

Referenced by DoYourJob().

◆ HandleStopButton()

void MockPlugin.SampleList.MockSampleListWorker.HandleStopButton ( ShowPluginIsInCharge win )

private

Definition at line 155 of file MockSampleListWorker.cs.

        {
            // This is just a quick and dirty piece of code for showing the IStopRun interface usage.
            // 
            win.StopButton.Click += (s, e) =>
            {
                win.StopButton.IsEnabled = false;
                var stopWaiter = mStopRun.Invoke(new StopRunArgs() { How = StopRunArgs.StopMode.NoNewJobs, RestartRemainingJobs = false,StopQueue = true});
                stopWaiter.ContinueWith((t) =>
                {
                    try
                    {
                        win.StopButton.IsEnabled = true;
                    }
                    catch
                    {
                        // suppress exceptions in case the button does not exist any more
                    }
                }, Helpers.Gui.GuiThreadScheduler);
            };
        }

References AxelSemrau.Chronos.Plugin.Helpers.Gui, AxelSemrau.Chronos.Plugin.IGuiHelper.GuiThreadScheduler, and mStopRun.

Referenced by DoYourJob().

◆ OneMoreScheduleWanted()

bool MockPlugin.SampleList.MockSampleListWorker.OneMoreScheduleWanted ( Window ownerWin )

private

Ask the user if he wants to start more schedules.

Parameters

ownerWin

Returns

For a real plugin, this could be some check whether the analytical results of the last sample require intervention or not, before injecting the next sample.

Definition at line 60 of file MockSampleListWorker.cs.

        {
            bool oneMore = false;
            DoOnGUIThread(() => oneMore = MessageBox.Show(ownerWin, "Start one more?",
                "Restart loop",
                MessageBoxButton.YesNo,
                MessageBoxImage.Question) == MessageBoxResult.Yes);
            return oneMore;
        }

References DoOnGUIThread().

Referenced by DoYourJob().

◆ OnPropertyChanged()

virtual void MockPlugin.SampleList.MockSampleListWorker.OnPropertyChanged ( [CallerMemberName] string propertyName = null )

protectedvirtual

Definition at line 225 of file MockSampleListWorker.cs.

        {
            PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
        }

References PropertyChanged.

Referenced by DoYourJob().

◆ TurnOffResets()

void MockPlugin.SampleList.MockSampleListWorker.TurnOffResets ( )

private

Definition at line 177 of file MockSampleListWorker.cs.

        {
            foreach (var somePAL in ConfiguredDevices.OfType<IPal3Access>())
            {
                somePAL.Options.AlwaysResetAfterSequence = false;
                somePAL.Options.ResetBeforeSequence = false;
            }
        }

References ConfiguredDevices.

Referenced by DoYourJob().

Member Data Documentation

◆ mGuiFactory

readonly TaskFactory MockPlugin.SampleList.MockSampleListWorker.mGuiFactory

private

Definition at line 38 of file MockSampleListWorker.cs.

Referenced by DoOnGUIThread(), and MockSampleListWorker().

◆ mStopRun

Func<StopRunArgs, Task> MockPlugin.SampleList.MockSampleListWorker.mStopRun

private

Definition at line 247 of file MockSampleListWorker.cs.

Referenced by HandleAbortButton(), and HandleStopButton().

◆ NormalButtonLabel

const string MockPlugin.SampleList.MockSampleListWorker.NormalButtonLabel = "Run plugin provided\r\nsample lists"

staticprivate

Definition at line 37 of file MockSampleListWorker.cs.

Referenced by DoYourJob().

Property Documentation

◆ ButtonCaption

string MockPlugin.SampleList.MockSampleListWorker.ButtonCaption = NormalButtonLabel

getprivate set

Shown on the sample list page.

You can update this using INotifyPropertyChanged.

Implements AxelSemrau.Chronos.Plugin.IWorkWithSampleLists.

Definition at line 48 of file MockSampleListWorker.cs.

48{ get; private set; } = NormalButtonLabel;

Referenced by DoYourJob().

◆ ButtonIcon

System.Drawing.Icon MockPlugin.SampleList.MockSampleListWorker.ButtonIcon = Properties.Resources.MockNormal

getprivate set

Shown in the button, preferred size 22x22.

You can update this using INotifyPropertyChanged.

Implements AxelSemrau.Chronos.Plugin.IWorkWithSampleLists.

Definition at line 50 of file MockSampleListWorker.cs.

50{ get; private set; } = Properties.Resources.MockNormal;

Referenced by DoYourJob().

◆ ConfiguredDevices

IEnumerable<IDevice> MockPlugin.SampleList.MockSampleListWorker.ConfiguredDevices

getset

List of IDevice for all configured devices in Chronos.

Use with caution!

Implements AxelSemrau.Chronos.Plugin.IDirectDeviceAccess.

Definition at line 214 of file MockSampleListWorker.cs.

214{ get; set; }

Referenced by TurnOffResets().

◆ LogPaths

IEnumerable<string> MockPlugin.SampleList.MockSampleListWorker.LogPaths

get

Provide full paths to each of your log files here.

Implements AxelSemrau.Chronos.Plugin.IProvideDiagnosticLogs.

Definition at line 230 of file MockSampleListWorker.cs.

◆ SampleList

ISampleListAccessor MockPlugin.SampleList.MockSampleListWorker.SampleList

set

Here we get an helper that allows us to manipulate the current sample list.

Implements AxelSemrau.Chronos.Plugin.INeedCellAccess.

Definition at line 202 of file MockSampleListWorker.cs.

        {
            set
            {
                // not using it in this demo plugin yet
            }
        }

◆ StopRun

Func<StopRunArgs, Task> MockPlugin.SampleList.MockSampleListWorker.StopRun

set

Callback function returning a task that completes once the schedule queue was stopped.

Implements AxelSemrau.Chronos.Plugin.IStopRuns.

Definition at line 248 of file MockSampleListWorker.cs.

        {
            set => mStopRun = value;
        }

Event Documentation

◆ PropertyChanged

PropertyChangedEventHandler MockPlugin.SampleList.MockSampleListWorker.PropertyChanged

Definition at line 223 of file MockSampleListWorker.cs.

Referenced by OnPropertyChanged().

◆ RunSampleList

RunSampleListHandler MockPlugin.SampleList.MockSampleListWorker.RunSampleList

Definition at line 195 of file MockSampleListWorker.cs.

Referenced by DoYourJob().

The documentation for this class was generated from the following file:

MockSampleListWorker.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Events

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MockSampleListWorker()

Member Function Documentation

◆ Dispose()

◆ DoOnGUIThread()

◆ DoYourJob()

◆ GetFakeLogs()

◆ HandleAbortButton()

◆ HandleStopButton()

◆ OneMoreScheduleWanted()

◆ OnPropertyChanged()

◆ TurnOffResets()

Member Data Documentation

◆ mGuiFactory

◆ mStopRun

◆ NormalButtonLabel

Property Documentation

◆ ButtonCaption

◆ ButtonIcon

◆ ConfiguredDevices

◆ LogPaths

◆ SampleList

◆ StopRun

Event Documentation

◆ PropertyChanged

◆ RunSampleList