Click or drag to resize

WriteTextSerialPortAutomation Class

Provides an automation job element that writes to a serial port.
Inheritance Hierarchy
SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.JobElementBaseJobElement
      RAYLASE.Marker.JobElementBaseAutomationJobElement
        RAYLASE.Marker.JobElementBaseAutomationJobElementGuid
          RAYLASE.Marker.JobElementBaseOnHardwareAutomationGuid
            RAYLASE.Marker.JobElementBaseWriteSerialPortAutomation
              RAYLASE.MarkerPlugin.JobElementsWriteTextSerialPortAutomation

Namespace: RAYLASE.MarkerPlugin.JobElements
Assembly: RAYLASE.MarkerPlugin (in RAYLASE.MarkerPlugin.dll) Version: 2.19.0
Syntax
C#
public class WriteTextSerialPortAutomation : BaseWriteSerialPortAutomation

The WriteTextSerialPortAutomation type exposes the following members.

Constructors
 NameDescription
Public methodWriteTextSerialPortAutomationInitializes a new instance of the Object class.
Top
Properties
 NameDescription
Protected propertyApplicationDataDirectory The directory where application data, such as logs and configurations, are stored.
(Inherited from BaseJobElement)
Public propertyCanRunOnScanController The flag to indicate whether the automation can run as a command list.
(Inherited from BaseWriteSerialPortAutomation)
Public propertyCondition The binning condition for the holder of the job element.
(Inherited from BaseJobElement)
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Public propertyController The serial controller to be used.
(Inherited from BaseWriteSerialPortAutomation)
Public propertyDelay The delay, in ms, between the last received response to the next data transmition.
(Inherited from BaseWriteSerialPortAutomation)
Protected propertyDeviceManager
(Inherited from BaseJobElement)
Protected propertyDirtyFlagLocker The lock object for property modification.
(Inherited from BaseJobElement)
Protected propertyDoHandleConditionPortChangedDelegate
(Inherited from BaseJobElement)
Public propertyExecutions The number of times this job element should be executed.
(Inherited from BaseOnHardwareAutomationT)
Public propertyIsDirty The flag to indicate whether the content of this job element has been modified.
(Inherited from BaseJobElement)
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.
(Inherited from BaseJobElement)
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 propertyPortName The name of the serial port.
(Inherited from BaseWriteSerialPortAutomation)
Public propertyPortValues The values to write to the port.
(Inherited from BaseWriteSerialPortAutomation)
Public propertyPropertyMask
(Inherited from BaseJobElement)
Public propertyScanControllerAutomationFeatureType The type of the automation that can be run on the scan controller.
(Inherited from BaseOnHardwareAutomationT)
Public propertyShouldExecute The flag to indicate whether the job element should be marked.
(Inherited from BaseAutomationJobElement)
Public propertyShowConditionControllerUIDelegate The delegate to show the controller UI because no ports have been defined.
(Inherited from BaseJobElement)
Protected propertyVariableManager
(Inherited from BaseJobElement)
Public propertyVariableScopeName
(Inherited from BaseJobElement)
Top
Methods
 NameDescription
Public methodCompareWith
(Inherited from BaseJobElement)
Public methodCopyFrom Copies the source job element into this job element.
(Inherited from BaseJobElement)
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean)
(Inherited from BasePlugin)
Public methodDisposeUI
(Inherited from BaseJobElement)
Protected methodDoCompareWith
(Inherited from BaseJobElement)
Protected methodDoDisposeUI
(Inherited from BasePlugin)
Protected methodDoGetUIMask
(Inherited from BaseJobElement)
Protected methodDoShowUI(String)
(Inherited from BaseJobElement)
Protected methodDoShowUI(JobElementHolder, String)
(Overrides BaseJobElementDoShowUI(JobElementHolder, String))
Protected methodDoShowUI(JobElementHolder, String, PropertyMask)
(Inherited from BaseJobElement)
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.
(Inherited from BaseJobElement)
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.
(Overrides BaseJobElementDoShowUICallback(JobElementHolder, PluginSettingsView))
Protected methodExecute(JobElementHolder) Writes to an output port as on-host execution.
(Overrides BaseAutomationJobElementTExecute(JobElementHolder))
Protected methodExecute(JobElementHolder, NullableGuid) Executes the automation and return the result.
(Inherited from BaseOnHardwareAutomationT)
Protected methodExecute(JobElementHolder, IOPortCondition, NullableGuid) Writes to an output port as on-card execution.
(Overrides BaseOnHardwareAutomationTExecute(JobElementHolder, IOPortCondition, NullableGuid))
Protected methodGenerateLocalTag
(Inherited from BaseJobElement)
Public methodGetUIMask
(Inherited from BaseJobElement)
Public methodHandleConditionPortChanged Performs necessary adjustments whenever the controller has updated its ports.
(Inherited from BaseJobElement)
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Overrides BasePluginInitialize)
Public methodShowUI(String)
(Inherited from BaseJobElement)
Public methodShowUI(JobElementHolder, String)
(Inherited from BaseJobElement)
Public methodShowUI(JobElementHolder, String, PropertyMask)
(Inherited from BaseAutomationJobElementT)
Public methodShowUICallback(PluginSettingsView)
(Inherited from BaseJobElement)
Public methodShowUICallback(JobElementHolder, PluginSettingsView)
(Inherited from BaseAutomationJobElementT)
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)
(Inherited from BaseJobElement)
Public methodToString
(Inherited from BasePlugin)
Protected methodUpdateFieldT Updates the Property to the value by using DirtyFlagLocker and setting IsDirty .
(Inherited from BaseJobElement)
Top
See Also