MockPlugin.Tasks.JobInspectionDemo Class Reference

Shows how to get information about other tasks in the schedule. More...

Inheritance diagram for MockPlugin.Tasks.JobInspectionDemo:

Collaboration diagram for MockPlugin.Tasks.JobInspectionDemo:

Properties
IInspectJob INeedToInspectOtherTasks.	JobInspector [set]
	The JobInspector lets you see information about other tasks and their properties.
JITCheckerDelegate	JITChecker [set]
	Chronos will provide a function that you can use to check for JIT expressions in properties.

Private Member Functions
void ITask.	PreValidate ()
	Called before the schedule construction is completed.
void	DisablePreviousTwin ()
	Shows how you can disable other tasks in the schedule creation phase. If there's a previous JobInspectionDemo task, let's turn it off.
void ITask.	PostValidate ()
	Called after the schedule construction is completed.
string	GetJitInfo (ITaskInfo someTaskInfo, IAccessProperty somePropInfo)
void ITask.	Execute ()
	Do whatever you have to do with your parameters.
string ITask.	GetTaskAction ()
	Description of the tasks's action (for hints/time table)

Private Attributes
IInspectJob	mJobInspector
JITCheckerDelegate	mJitChecker

Detailed Description

Shows how to get information about other tasks in the schedule.

Definition at line 12 of file MockJobInspectingTask.cs.

Member Function Documentation

DisablePreviousTwin()

void MockPlugin.Tasks.JobInspectionDemo.DisablePreviousTwin ( )

private

Shows how you can disable other tasks in the schedule creation phase. If there's a previous JobInspectionDemo task, let's turn it off.

Exceptions

System.NotImplementedException

Definition at line 30 of file MockJobInspectingTask.cs.

        {
            var prevTask = mJobInspector.CompleteSchedule
                .TakeWhile(someTaskInfo => someTaskInfo.PluginTask != mJobInspector.CurrentTask.PluginTask).LastOrDefault();
            if (prevTask?.PluginTask is JobInspectionDemo)
            {
                prevTask.Enabled = false;
            }
        }

References mJobInspector.

Referenced by PostValidate().

Execute()

void ITask. MockPlugin.Tasks.JobInspectionDemo.Execute ( )

private

Do whatever you have to do with your parameters.

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 53 of file MockJobInspectingTask.cs.

        {
            var sb = new StringBuilder();
            var i = 1;
            foreach (var someTaskInfo in mJobInspector.JobsTasks)
            {
                sb.AppendLine($"Task {i++}");
                sb.AppendFormat("Class {0}, {1} properties\r\n",
                    someTaskInfo.Task.GetType().Name,
                    someTaskInfo.PropertyAccessInfos.Count());
                foreach (var somePropInfo in someTaskInfo.PropertyAccessInfos)
                {
                    sb.AppendFormat("Property {0}: {1}, jit? {2}\r\n",
                        somePropInfo.PropInfo.Name,
                        somePropInfo.PropInfo.GetValue(somePropInfo.BaseObject, null),
                        GetJitInfo(someTaskInfo,somePropInfo));
                }
                sb.AppendLine();
            }
            System.Windows.Forms.MessageBox.Show(Helpers.Gui.MainWindow, sb.ToString(), "Checked other tasks");
        }

References GetJitInfo(), AxelSemrau.Chronos.Plugin.Helpers.Gui, AxelSemrau.Chronos.Plugin.IGuiHelper.MainWindow, and mJobInspector.

GetJitInfo()

string MockPlugin.Tasks.JobInspectionDemo.GetJitInfo ( ITaskInfo someTaskInfo, IAccessProperty somePropInfo )

private

Definition at line 45 of file MockJobInspectingTask.cs.

        {
            if(mJitChecker == null)
            {
                return "N/A";
            }
            return mJitChecker(someTaskInfo.Task,somePropInfo.FullPath) ? "yes" : "no";
        }

References AxelSemrau.Chronos.Plugin.IAccessProperty.FullPath, mJitChecker, and AxelSemrau.Chronos.Plugin.ITaskInfo.Task.

Referenced by Execute().

GetTaskAction()

string ITask. MockPlugin.Tasks.JobInspectionDemo.GetTaskAction ( )

private

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

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 75 of file MockJobInspectingTask.cs.

        {
            return "Snooping around";
        }

PostValidate()

void ITask. MockPlugin.Tasks.JobInspectionDemo.PostValidate ( )

private

Called after the schedule construction is completed.

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 40 of file MockJobInspectingTask.cs.

        {
            DisablePreviousTwin();
        }

References DisablePreviousTwin().

PreValidate()

void ITask. MockPlugin.Tasks.JobInspectionDemo.PreValidate ( )

private

Called before the schedule construction is completed.

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 16 of file MockJobInspectingTask.cs.

        {
            if (mJitChecker != null)
            {
                System.Windows.Forms.MessageBox.Show(Helpers.Gui.MainWindow,
                    $"My enabled property {(mJitChecker(this, "Enabled") ? "will be set by a JIT expression" : "has an ordinary value")}", "JobInspectionDemo");
            }
        }

References AxelSemrau.Chronos.Plugin.Helpers.Gui, AxelSemrau.Chronos.Plugin.IGuiHelper.MainWindow, and mJitChecker.

Member Data Documentation

mJitChecker

JITCheckerDelegate MockPlugin.Tasks.JobInspectionDemo.mJitChecker

private

Definition at line 94 of file MockJobInspectingTask.cs.

Referenced by GetJitInfo(), and PreValidate().

mJobInspector

IInspectJob MockPlugin.Tasks.JobInspectionDemo.mJobInspector

private

Definition at line 84 of file MockJobInspectingTask.cs.

Referenced by DisablePreviousTwin(), and Execute().

Property Documentation

JITChecker

JITCheckerDelegate MockPlugin.Tasks.JobInspectionDemo.JITChecker

set

Chronos will provide a function that you can use to check for JIT expressions in properties.

Implements AxelSemrau.Chronos.Plugin.INeedToCheckForJITLinks.

Definition at line 95 of file MockJobInspectingTask.cs.

{ set => mJitChecker = value; }

JobInspector

IInspectJob INeedToInspectOtherTasks. MockPlugin.Tasks.JobInspectionDemo.JobInspector

setprivate

The JobInspector lets you see information about other tasks and their properties.

Implements AxelSemrau.Chronos.Plugin.INeedToInspectOtherTasks.

Definition at line 86 of file MockJobInspectingTask.cs.

        {
            set => mJobInspector = value;
        }

---

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

• MockJobInspectingTask.cs