Chronos Plugins 5.4.0
This documentation covers the plugin interfaces definitions and an example implementation.
Loading...
Searching...
No Matches
AxelSemrau.Chronos.Plugin.ITaskInfo Interface Reference

Gives access to a task's implementation and to all user visible properties. More...

+ Inheritance diagram for AxelSemrau.Chronos.Plugin.ITaskInfo:

Properties

int JobNo [get]
 Gets the job index.
 
int TaskIndex [get]
 Gets the index of the task.
 
object Task [get]
 Task object, Chronos internal type.
 
IEnumerable< IAccessPropertyPropertyAccessInfos [get]
 Enumeration of all visible properties of this task.
 
IDevice Autosampler [get]
 Get the Plugin-friendly wrapper for the task's autosampler, if available, else null.
 
ITask PluginTask [get]
 Gets the unwrapped ITask implementation if this is a plugin task, else null.
 
int UserVisibleIndex [get]
 The index as seen in the method editor.
 
int? RepeatCounter [get]
 If this is within a repeat loop, the respective iteration number, else null.
 
bool Enabled [get, set]
 Should this task be executed?
 
int StartTime [get]
 Time relative to schedule start in seconds when this task was started / will be started.
 
int Runtime [get]
 Task duration in seconds.
 

Detailed Description

Gives access to a task's implementation and to all user visible properties.

Do not implement this, it's a parameter of IInspectJob

Definition at line 290 of file TaskInterfaces.cs.

Property Documentation

◆ Autosampler

IDevice AxelSemrau.Chronos.Plugin.ITaskInfo.Autosampler
get

Get the Plugin-friendly wrapper for the task's autosampler, if available, else null.

Definition at line 320 of file TaskInterfaces.cs.

320{ get; }

◆ Enabled

bool AxelSemrau.Chronos.Plugin.ITaskInfo.Enabled
getset

Should this task be executed?

Only disable other tasks if you are sure that you know what you are doing. This can have a lot of side effects. Available since API 1.1.0

Definition at line 345 of file TaskInterfaces.cs.

345{ get; set; }

◆ JobNo

int AxelSemrau.Chronos.Plugin.ITaskInfo.JobNo
get

Gets the job index.

The zero-based job index

Definition at line 298 of file TaskInterfaces.cs.

298{ get; }

◆ PluginTask

ITask AxelSemrau.Chronos.Plugin.ITaskInfo.PluginTask
get

Gets the unwrapped ITask implementation if this is a plugin task, else null.

Definition at line 324 of file TaskInterfaces.cs.

324{ get; }

Referenced by MockPlugin.Tasks.JobInspectionDemo.DisablePreviousTwin().

◆ PropertyAccessInfos

IEnumerable<IAccessProperty> AxelSemrau.Chronos.Plugin.ITaskInfo.PropertyAccessInfos
get

Enumeration of all visible properties of this task.

Definition at line 316 of file TaskInterfaces.cs.

316{ get; }

◆ RepeatCounter

int? AxelSemrau.Chronos.Plugin.ITaskInfo.RepeatCounter
get

If this is within a repeat loop, the respective iteration number, else null.

Definition at line 335 of file TaskInterfaces.cs.

335{ get; }

◆ Runtime

int AxelSemrau.Chronos.Plugin.ITaskInfo.Runtime
get

Task duration in seconds.

Available since API 1.1.0

Definition at line 360 of file TaskInterfaces.cs.

360{ get; }

◆ StartTime

int AxelSemrau.Chronos.Plugin.ITaskInfo.StartTime
get

Time relative to schedule start in seconds when this task was started / will be started.

Obviously only available after schedule planning is completed. Available since API 1.1.0

Definition at line 353 of file TaskInterfaces.cs.

353{ get; }

◆ Task

object AxelSemrau.Chronos.Plugin.ITaskInfo.Task
get

Task object, Chronos internal type.

Definition at line 311 of file TaskInterfaces.cs.

311{ get; }

Referenced by MockPlugin.Tasks.TaskListAttribute.GetCaffeineInfo(), and MockPlugin.Tasks.JobInspectionDemo.GetJitInfo().

◆ TaskIndex

int AxelSemrau.Chronos.Plugin.ITaskInfo.TaskIndex
get

Gets the index of the task.

The index of the task.

Definition at line 306 of file TaskInterfaces.cs.

306{ get; }

◆ UserVisibleIndex

int AxelSemrau.Chronos.Plugin.ITaskInfo.UserVisibleIndex
get

The index as seen in the method editor.

Please note that this is the same for all iterations of a repeat loop.

Definition at line 331 of file TaskInterfaces.cs.

331{ get; }

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