Click or drag to resize

BaseJobDefinitionConverter Class

Provides the base class for converting a job definition to a stream and vice-versa.
Inheritance Hierarchy
SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.JobBaseJobDefinitionConverter
      RAYLASE.MarkerPlugin.ExportersExportJobDefinitionConverter

Namespace: RAYLASE.Marker.Job
Assembly: RAYLASE.Marker.Job (in RAYLASE.Marker.Job.dll) Version: 2.19.0
Syntax
C#
public abstract class BaseJobDefinitionConverter : BasePlugin, 
	ISerializationConverter<JobDefinition, LoadJobDefinitionResult>

The BaseJobDefinitionConverter type exposes the following members.

Constructors
 NameDescription
Protected methodBaseJobDefinitionConverterInitializes a new instance of the Object class.
Top
Properties
 NameDescription
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Protected propertyLogDirectory The directory of the log file.
(Inherited from BasePlugin)
Public propertyLogger The common logger.
(Inherited from BasePlugin)
Public propertyNeedsDryRun The flag whether a dry-run is needed to preprocess the serialization.
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)
Public propertySerializationLabel 
Public propertySerializationType The unique ID to represent this converter. This will be used as the extension of the converted file.
Public propertySerializationVersion 
Top
Methods
 NameDescription
Public methodCreateJob Creates a new job instance.
Public methodDeserialize Deserializes from a given stream into an object.
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean)
(Inherited from BasePlugin)
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)
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin)
Public methodReadSerializationVersion 
Public methodSerialize(JobDefinition, Stream) Serializes a given job into a stream.
Public methodSerialize(JobDefinition, Stream, ActionEventHandlerProcessingStageFinishedEventArgs) Serializes a given job into a stream by preprocessing the job with a dry-run.
Public methodShowUI
(Overrides BasePluginShowUI(String))
Public methodShowUICallback
(Overrides BasePluginShowUICallback(PluginSettingsView))
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)
Protected methodWriteJobDefinitionVersion 
Top
See Also