IJob |
Represents the interface that provides the functionalities to load, save, and run jobs. Jobs are also possible to be run in a batch, in a sequential or parallel way.
Namespace: RAYLASE.Marker.Job
Assembly: RAYLASE.Marker.Job (in RAYLASE.Marker.Job.dll) Version: 2.19.0
SyntaxC#
public interface IJobManager
The IJobManager type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | JobExecutorTypes | A read-only list of available job executors. |
| SupportedJobfileLabelAndTypes | Gets the labels and extensions of the supported file types. |
| SupportedJobfileTypes | Obsolete. |
Methods| Name | Description | |
|---|---|---|
 | CreateNewJob | Creates a new job with a specific description. |
| DryRunAsync | Performs a dry run of the job. It will build all job elements and calculates the bounding boxes and execution time. |
| ExportJob(JobDefinition, Stream, String) | Streams a given job in the specified format. |
| ExportJob(JobDefinition, String, String) | Exports a job in the specified format to a given file path. |
| GenerateJobExecutorProfile | Returns a specific type of job executor profile to be prepared and then used for execution. |
| GetOrRegisterVariableScope | |
| ImportJob(Stream, String) | Loads from a given stream of a specific format and creates the corresponding job. Missing items will be reported back in the return value. |
| ImportJob(String, String) | Imports from a given saved file of a specific format and creates the corresponding job. Missing items will be reported back in the return value. |
| LoadJob(Stream) | Loads from a given stream and creates the corresponding job. Missing items will be reported back in the return value. |
| LoadJob(String) | Loads a given saved file and creates the corresponding job. Missing items will be reported back in the return value. |
| RemoveJobDefinitionFromJobsValidator | Removes a JobDefinition from the JobsValidator; called when the user closes a job. |
| RenderAsBitmap(JobDefinition, String, Int32) | Stores job workspace as bitmap. |
| RenderAsBitmap(JobDefinition, String, Int32, Double, Color, NullableColor) | Stores job workspace as bitmap. |
| RenderAsBitmapDpi | Stores job workspace as bitmap. |
| RenderAsImage(JobDefinition, Int32) | Returns an image of the jobs workspace. |
| RenderAsImage(JobDefinition, Int32, Double, Color, NullableColor) | Returns an image of the jobs workspace. |
| RenderAsImageDpi | Stores job workspace as bitmap. |
| RunAsync(JobDefinition, BaseJobExecutorProfile, CancellationTokenSource) | Runs asynchronously a given job with a given profile. The default scan controller will be the first listed in the job. |
| RunAsync(JobDefinition, Type, CancellationTokenSource) | Runs asynchronously a given job with a specific type of job executor using its default profile. The default scan controller will be the first listed in the job. |
| RunJobElementsAsync(IListBaseJobElement, IListBaseScanController, BaseJobExecutorProfile, CancellationTokenSource) | Runs asynchronously a given list of job elements with a given profile. |
| RunJobElementsAsync(IListBaseJobElement, IListBaseScanController, Type, CancellationTokenSource) | Runs asynchronously a given list of job elements with a specific type of job executor. |
| RunJobElementsAsync(IListJobElementHolder, IListBaseScanController, BaseJobExecutorProfile, CancellationTokenSource) | Runs asynchronously a given list of job element holders with a given profile. |
| RunJobElementsAsync(IListJobElementHolder, IListBaseScanController, Type, CancellationTokenSource) | Runs asynchronously a given list of job element holders with a specific type of job executor. |
| RunSync(JobDefinition, BaseJobExecutorProfile, CancellationTokenSource) | Runs synchronously a given job with a given profile. The default scan controller will be the first listed in the job. If job contains multiple scan controllers, it will be executed sequentially. Use RunAsync(JobDefinition, BaseJobExecutorProfile, CancellationTokenSource) for parallel execution. |
| RunSync(JobDefinition, Type, CancellationTokenSource) | Runs synchronously a given job with a specific type of job executor using its default profile. The default scan controller will be the first listed in the job. If job contains multiple scan controllers, it will be executed sequentially. Use RunAsync(JobDefinition, Type, CancellationTokenSource) for parallel execution. |
| SaveJob(JobDefinition, Stream) | Streams a given job. |
| SaveJob(JobDefinition, String) | Saves a job to a given file path. |
| SetWorkspaceProcessTransformation(dmat4, JobDefinition) | Sets the process transformation for all scan controller contained in the job. Center of transformation is the origin of the workspace. |
| SetWorkspaceProcessTransformation(dmat4, String) | Sets the process transformation for all scan controller contained in the workspace configuration. Center of transformation is the origin of the workspace. |
| UnregisterVariableScope | |
| ValidateJobDefinition | Validates all job elements of the given JobDefinition. |
Events| Name | Description | |
|---|---|---|
 | RunJobProgressed |
See Also