Chronos Plugins 5.9.0
This documentation covers the plugin interfaces definitions and an example implementation.
All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Pages
AxelSemrau.Chronos.Plugin.RunSampleListEventArgs Class Reference

Parameters for sample list loading and schedule creation. More...

+ Inheritance diagram for AxelSemrau.Chronos.Plugin.RunSampleListEventArgs:
+ Collaboration diagram for AxelSemrau.Chronos.Plugin.RunSampleListEventArgs:

Public Attributes

string SampleListFile
 Full path to a sample list file which should be executed.
 
bool StartAndWaitForEnd = true
 If false, the schedule is just created and appended to the queue.
 
bool OptimizationRun = false
 Try to optimize the task run times.
 
bool ExtendLastPlanner = false
 Set this to true if you want to extend the last queued planner (or the one given in InjectIntoPlanner) if possible instead of creating a new planner.
 
bool SwitchToSchedulesView = true
 Use this to suppress the default behavior of switching to the schedules view when a schedule is started.
 
bool JustStartQueue = false
 Ignore the other parameters, just start the schedule queue as it is.
 
bool RespectSelection = true
 Run only samples from the selected lines.
 
IPlannerInfo InjectIntoPlanner
 Enables injection of jobs into a specific planner instead of only the last of the queue (see ExtendLastPlanner />
 
int InsertAtJobIndex = -1
 The zero based index for the job list where the new samples should be inserted. If -1, just append. See ExtendLastPlanner
 

Detailed Description

Parameters for sample list loading and schedule creation.

Definition at line 67 of file SampleListWorkerInterfaces.cs.

Member Data Documentation

◆ ExtendLastPlanner

bool AxelSemrau.Chronos.Plugin.RunSampleListEventArgs.ExtendLastPlanner = false

Set this to true if you want to extend the last queued planner (or the one given in InjectIntoPlanner) if possible instead of creating a new planner.

The current implementation does not yet check for autosampler specific settings like syringe or tray temperatures. Also check InsertAtJobIndex

Definition at line 94 of file SampleListWorkerInterfaces.cs.

◆ InjectIntoPlanner

IPlannerInfo AxelSemrau.Chronos.Plugin.RunSampleListEventArgs.InjectIntoPlanner

Enables injection of jobs into a specific planner instead of only the last of the queue (see ExtendLastPlanner />

Definition at line 111 of file SampleListWorkerInterfaces.cs.

◆ InsertAtJobIndex

int AxelSemrau.Chronos.Plugin.RunSampleListEventArgs.InsertAtJobIndex = -1

The zero based index for the job list where the new samples should be inserted. If -1, just append. See ExtendLastPlanner

Definition at line 115 of file SampleListWorkerInterfaces.cs.

◆ JustStartQueue

bool AxelSemrau.Chronos.Plugin.RunSampleListEventArgs.JustStartQueue = false

Ignore the other parameters, just start the schedule queue as it is.

Definition at line 103 of file SampleListWorkerInterfaces.cs.

◆ OptimizationRun

bool AxelSemrau.Chronos.Plugin.RunSampleListEventArgs.OptimizationRun = false

Try to optimize the task run times.

Just like you do it by right-clicking a method in the sample list. The first line of the given sample list is the one that will be optimized.

Definition at line 86 of file SampleListWorkerInterfaces.cs.

◆ RespectSelection

bool AxelSemrau.Chronos.Plugin.RunSampleListEventArgs.RespectSelection = true

Run only samples from the selected lines.

Definition at line 107 of file SampleListWorkerInterfaces.cs.

◆ SampleListFile

string AxelSemrau.Chronos.Plugin.RunSampleListEventArgs.SampleListFile

Full path to a sample list file which should be executed.

If left null, the current list will be used.

Definition at line 75 of file SampleListWorkerInterfaces.cs.

◆ StartAndWaitForEnd

bool AxelSemrau.Chronos.Plugin.RunSampleListEventArgs.StartAndWaitForEnd = true

If false, the schedule is just created and appended to the queue.

Definition at line 79 of file SampleListWorkerInterfaces.cs.

◆ SwitchToSchedulesView

bool AxelSemrau.Chronos.Plugin.RunSampleListEventArgs.SwitchToSchedulesView = true

Use this to suppress the default behavior of switching to the schedules view when a schedule is started.

Definition at line 99 of file SampleListWorkerInterfaces.cs.


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