Click or drag to resize

BaseThreadCoordinatedJobExecutor Class

Represents the base class for plugins of type job executors.
Inheritance Hierarchy

Namespace: RAYLASE.Marker.Job.Executor
Assembly: RAYLASE.Marker.Job (in RAYLASE.Marker.Job.dll) Version: 2.20.0
Syntax
C#
Copy
public abstract class BaseThreadCoordinatedJobExecutor : BaseJobExecutor

The BaseThreadCoordinatedJobExecutor type exposes the following members.

Constructors
 NameDescription
Protected methodBaseThreadCoordinatedJobExecutorInitializes a new instance of the Object class.
Top
Properties
 NameDescription
Public propertyCancellationTokenSource
(Overrides BaseJobExecutor.CancellationTokenSource)
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Protected propertyJobElementManager The job element manager.
Protected propertyJobExecutorProfile
(Inherited from BaseJobExecutor)
Protected propertyLogDirectory The directory of the log file.
(Inherited from BasePlugin)
Public propertyLogger The common logger.
(Inherited from BasePlugin)
Protected propertyPathFactory 
Public propertyPluginMetadata 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)
Protected propertyScanControllers The active scan controller for the execution.
Top
Methods
 NameDescription
Protected methodApplyBaseProfile Applies the given job executor profile. The properties of BaseJobExecutorProfile are applied here.
(Inherited from BaseJobExecutor)
Protected methodApplyCustomProfile Applies the given job executor profile. The properties that are specific to the concrete class should be applied here.
(Inherited from BaseJobExecutor)
Protected methodCleanUpProcess Runs the extra logic after the main process is done.
Public methodDispose()
(Inherited from BasePlugin)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the BaseThreadCoordinatedJobExecutor and optionally releases the managed resources
(Overrides BasePlugin.Dispose(Boolean))
Public methodDisposeUI Disposes the given setting view.
(Inherited from BasePlugin)
Protected methodDoDisposeUI
(Inherited from BasePlugin)
Protected methodDoShowUI Shows the specific UI embedded in the plug-in instance. The content will be wrapped by a preset view.
(Inherited from BasePlugin)
Protected methodDoShowUICallback Invokes the callback that can be used when the DoShowUI method is done.
(Inherited from BasePlugin)
Protected methodExecuteSingleList
(Overrides BaseJobExecutor.ExecuteSingleList(JobDefinition, BaseScanController))
Protected methodHandleAutomationJobElement 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.
Protected methodHandleChildJobElementProcessingStarting 
Protected methodHandleMarkableJobElement 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.
Protected methodHandleScanControllerError 
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin)
Protected methodOnJobElementExecuteListCalled
(Inherited from BaseJobExecutor)
Protected methodOnJobElementSetListCalled
(Inherited from BaseJobExecutor)
Protected methodOnRunJobEnded
(Inherited from BaseJobExecutor)
Protected methodOnRunJobStarted
(Inherited from BaseJobExecutor)
Protected methodPostIteration Runs the extra logic after the last job element is processed..
Protected methodPostRun Runs the extra process after the main process using the last scan controller, in the Run method, is done.
Protected methodPreIteration Runs the extra logic before the first job element is processed..
Protected methodPreRun Runs the preparation before the main process using the first scan controller, in the Run method, is done.
Protected methodRun Runs a given job definition.
(Overrides BaseJobExecutor.Run(JobDefinition, String))
Public methodShowUI
(Inherited from BaseJobExecutor)
Public methodShowUICallback
(Inherited from BaseJobExecutor)
Public methodShowUICancelCallback Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin)
Public methodToString
(Inherited from BasePlugin)
Top
Events
See Also