MockPlugin.Tasks.DumpConfigInfo Class Reference

This tasks uses the config helper to access some information about the instrument configuration and just dumps it to the runlog. More...

Inheritance diagram for MockPlugin.Tasks.DumpConfigInfo:

Collaboration diagram for MockPlugin.Tasks.DumpConfigInfo:

Public Member Functions
void	PreValidate ()
	Called before the schedule construction is completed. More...
void	PostValidate ()
	Called after the schedule construction is completed. More...
void	Execute ()
	Do whatever you have to do with your parameters. More...
string	GetTaskAction ()
	Description of the tasks's action (for hints/time table) More...

Events
Action< string >	WriteToRunlog
Events inherited from AxelSemrau.Chronos.Plugin.IHaveRunlogOutput
Action< string >	WriteToRunlog
	Use this event to send output to the Run Control / Runlog page and, if applicable, to the runlog file. More...

Detailed Description

This tasks uses the config helper to access some information about the instrument configuration and just dumps it to the runlog.

Definition at line 11 of file MockConfigUsingTask.cs.

Member Function Documentation

Execute()

void MockPlugin.Tasks.DumpConfigInfo.Execute

(

)

Do whatever you have to do with your parameters.

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 25 of file MockConfigUsingTask.cs.

        {
            var info = Helpers.Config;
            var sb = new StringBuilder();
            sb.AppendLine($"Path to methods: {info.PathToMethods}");
            sb.AppendLine($"Default sample lists location: {info.PathToSampleLists}");
            sb.AppendLine($"Location of instrument configuration: {info.PathToInstrumentConfig}");
            sb.AppendLine();
            sb.AppendLine("Trays:");
            foreach (var tray in info.Trays)
            {
                sb.AppendLine($"{tray.Name} on sampler {tray.Sampler?.ToString() ?? "N/A"}, valid indices {tray.FirstIndex} - {tray.LastIndex} ({tray.NoOfPositions} total)");
            }
            WriteToRunlog?.Invoke(sb.ToString());
        }

References AxelSemrau.Chronos.Plugin.Helpers.Config, and MockPlugin.Tasks.DumpConfigInfo.WriteToRunlog.

GetTaskAction()

string MockPlugin.Tasks.DumpConfigInfo.GetTaskAction

(

)

Description of the tasks's action (for hints/time table)

Implements AxelSemrau.Chronos.Plugin.ITask.

PostValidate()

void MockPlugin.Tasks.DumpConfigInfo.PostValidate

(

)

Called after the schedule construction is completed.

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 20 of file MockConfigUsingTask.cs.

        {
            // nothing
        }

PreValidate()

void MockPlugin.Tasks.DumpConfigInfo.PreValidate

(

)

Called before the schedule construction is completed.

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 15 of file MockConfigUsingTask.cs.

        {
            // nothing
        }

Event Documentation

WriteToRunlog

Action<string> MockPlugin.Tasks.DumpConfigInfo.WriteToRunlog

Definition at line 47 of file MockConfigUsingTask.cs.

Referenced by MockPlugin.Tasks.DumpConfigInfo.Execute().

---

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

• MockConfigUsingTask.cs