Base |
Represents the base class for plugins of type job executors.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.Job.ExecutorBaseJobExecutor
RAYLASE.Marker.Job.ExecutorBaseThreadCoordinatedJobExecutor
RAYLASE.Marker.InternalPlugin.JobExecutorsOnCardJobExecutor
RAYLASE.Marker.InternalPlugin.JobExecutorsOnHostJobExecutor
RAYLASE.Marker.InternalPlugin.JobExecutorsQuickJobExecutor
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.Job.ExecutorBaseJobExecutor
RAYLASE.Marker.Job.ExecutorBaseThreadCoordinatedJobExecutor
RAYLASE.Marker.InternalPlugin.JobExecutorsOnCardJobExecutor
RAYLASE.Marker.InternalPlugin.JobExecutorsOnHostJobExecutor
RAYLASE.Marker.InternalPlugin.JobExecutorsQuickJobExecutor
Namespace: RAYLASE.Marker.Job.Executor
Assembly: RAYLASE.Marker.Job (in RAYLASE.Marker.Job.dll) Version: 2.20.0
SyntaxC#
public abstract class BaseThreadCoordinatedJobExecutor : BaseJobExecutor
The BaseThreadCoordinatedJobExecutor type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BaseThreadCoordinatedJobExecutor | Initializes a new instance of the Object class. |
Properties| Name | Description | |
|---|---|---|
 | CancellationTokenSource | (Overrides BaseJobExecutorCancellationTokenSource) |
 | ConfigurationManager | (Inherited from BasePlugin) |
| JobElementManager | The job element manager. |
| JobExecutorProfile | (Inherited from BaseJobExecutor) |
| LogDirectory |
The directory of the log file.
(Inherited from BasePlugin) |
| Logger |
The common logger.
(Inherited from BasePlugin) |
| PathFactory | |
| PluginMetadata |
The metadata of the plugin instances. If the concrete class inherits from the BasePluginSetup interface, the metadata of the BasePluginSetup will be prefilled.
(Inherited from BasePlugin) |
| ScanControllers | The active scan controller for the execution. |
Methods| Name | Description | |
|---|---|---|
| ApplyBaseProfile |
Applies the given job executor profile. The properties of BaseJobExecutorProfile are applied here.
(Inherited from BaseJobExecutor) |
| ApplyCustomProfile |
Applies the given job executor profile. The properties that are specific to the concrete class should be applied here.
(Inherited from BaseJobExecutor) |
| CleanUpProcess | Runs the extra logic after the main process is done. |
 | Dispose | (Inherited from BasePlugin) |
| Dispose(Boolean) | Releases the unmanaged resources used by the BaseThreadCoordinatedJobExecutor and optionally releases the managed resources (Overrides BasePluginDispose(Boolean)) |
| DisposeUI |
Disposes the given setting view.
(Inherited from BasePlugin) |
| DoDisposeUI | (Inherited from BasePlugin) |
| DoShowUI |
Shows the specific UI embedded in the plug-in instance. The content will be wrapped by a preset view.
(Inherited from BasePlugin) |
| DoShowUICallback |
Invokes the callback that can be used when the DoShowUI method is done.
(Inherited from BasePlugin) |
| ExecuteSingleList | (Overrides BaseJobExecutorExecuteSingleList(JobDefinition, BaseScanController)) |
| HandleAutomationJobElement | Handles a given automation job element when it is being processed by its parent container. The base method will send this job element for further processing. |
| HandleChildJobElementProcessingStarting | |
| HandleMarkableJobElement | Handles a given markable job element when it is being processed by its parent container. The base method will send this job element for further processing. |
| HandleScanControllerError | |
| Initialize |
Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin) |
| OnJobElementExecuteListCalled | (Inherited from BaseJobExecutor) |
| OnJobElementSetListCalled | (Inherited from BaseJobExecutor) |
| OnRunJobEnded | (Inherited from BaseJobExecutor) |
| OnRunJobStarted | (Inherited from BaseJobExecutor) |
| PostIteration | Runs the extra logic after the last job element is processed.. |
| PostRun | Runs the extra process after the main process using the last scan controller, in the Run method, is done. |
| PreIteration | Runs the extra logic before the first job element is processed.. |
| PreRun | Runs the preparation before the main process using the first scan controller, in the Run method, is done. |
| Run |
Runs a given job definition.
(Overrides BaseJobExecutorRun(JobDefinition, String)) |
| ShowUI | (Inherited from BaseJobExecutor) |
| ShowUICallback | (Inherited from BaseJobExecutor) |
| ShowUICancelCallback |
Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin) |
| ToString | (Inherited from BasePlugin) |
Events| Name | Description | |
|---|---|---|
 | JobElementExecuteListCalled | (Inherited from BaseJobExecutor) |
| JobElementSetListCalled | (Inherited from BaseJobExecutor) |
| RunJobEnded | (Inherited from BaseJobExecutor) |
| RunJobStarted | (Inherited from BaseJobExecutor) |
See Also