Click or drag to resize

BaseJobElement Class

Provides a convenience to initialize a job element instance with a common setup such as the common logger and the unique ID.
Inheritance Hierarchy

Namespace: RAYLASE.Marker.JobElement
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.19.0
Syntax
C#
Copy
public abstract class BaseJobElement : BasePlugin

The BaseJobElement type exposes the following members.

Constructors
 NameDescription
Protected methodBaseJobElementInitializes a new instance of the Object class.
Top
Properties
 NameDescription
Protected propertyApplicationDataDirectory The directory where application data, such as logs and configurations, are stored.
Public propertyCondition The binning condition for the holder of the job element.
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Protected propertyDeviceManager 
Protected propertyDirtyFlagLocker The lock object for property modification.
Protected propertyDoHandleConditionPortChangedDelegate 
Public propertyIsDirty The flag to indicate whether the content of this job element has been modified.
Public propertyJobElementID The unique ID of the job element. If the concrete class inherits from BaseJobElement, the JobElementID of the BaseJobElement will be prefilled. Recommended not to be changed.
Protected propertyLogDirectory The directory of the log file.
(Inherited from BasePlugin)
Public propertyLogger The common logger.
(Inherited from BasePlugin)
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 propertyPropertyMask 
Public propertyShowConditionControllerUIDelegate The delegate to show the controller UI because no ports have been defined.
Protected propertyVariableManager 
Public propertyVariableScopeName 
Top
Methods
 NameDescription
Public methodCompareWith 
Public methodCopyFrom Copies the source job element into this job element.
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean)
(Inherited from BasePlugin)
Public methodDisposeUI
(Overrides BasePluginDisposeUI(PluginSettingsView))
Protected methodDoCompareWith 
Protected methodDoDisposeUI
(Inherited from BasePlugin)
Protected methodDoGetUIMask 
Protected methodDoShowUI(String)
(Overrides BasePluginDoShowUI(String))
Protected methodDoShowUI(JobElementHolder, String) 
Protected methodDoShowUI(JobElementHolder, String, PropertyMask) 
Protected methodDoShowUICallback(PluginSettingsView) This callback method is called when a GUI settings dialog is closed with Apply or OK and is used to extract the changed properties from a settings dialog in the GUI.
(Overrides BasePluginDoShowUICallback(PluginSettingsView))
Protected methodDoShowUICallback(JobElementHolder, PluginSettingsView) This callback method is called when a GUI settings dialog is closed with Apply or OK and is used to extract the changed properties from a settings dialog in the GUI.
Protected methodGenerateLocalTag 
Public methodGetUIMask 
Public methodHandleConditionPortChanged Performs necessary adjustments whenever the controller has updated its ports.
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin)
Public methodShowUI(String)
(Overrides BasePluginShowUI(String))
Public methodShowUI(JobElementHolder, String) 
Public methodShowUI(JobElementHolder, String, PropertyMask) 
Public methodShowUICallback(PluginSettingsView)
(Overrides BasePluginShowUICallback(PluginSettingsView))
Public methodShowUICallback(JobElementHolder, PluginSettingsView) 
Public methodShowUICancelCallback(PluginSettingsView) Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin)
Public methodShowUICancelCallback(JobElementHolder, PluginSettingsView) 
Public methodToString
(Inherited from BasePlugin)
Protected methodUpdateFieldT Updates the Property to the value by using DirtyFlagLocker and setting IsDirty .
Top
See Also