BaseWriteSerialPortAutomation Class

Represents the base class of all plugins of type on-hardware write-serial-port automation job elements. An on-hardware automation job element will perform its automation as a command on the scan controller.

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.Marker.JobElement
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.30.0

Syntax

Copy

public abstract class BaseWriteSerialPortAutomation : BaseOnHardwareAutomation<Guid>

The BaseWriteSerialPortAutomation type exposes the following members.

Constructors

	Name	Description
	BaseWriteSerialPortAutomation	Initializes a new instance of the Object class.

Top

Properties

	Name	Description
	ApplicationDataDirectory	The directory where application data, such as logs and configurations, are stored. (Inherited from BaseJobElement)
	CancellationToken	CancellationToken for canceling the delay if run on host. (Inherited from BaseAutomationJobElement)
	CanRunOnScanController	The flag to indicate whether the automation can run as a command list. (Overrides BaseOnHardwareAutomationTCanRunOnScanController)
	Condition	The binning condition for the holder of the job element. (Inherited from BaseJobElement)
	ConfigurationManager	(Inherited from BasePlugin)
	Controller	The serial controller to be used.
	Delay	The delay, in ms, between the last received response to the next data transmition.
	DeviceManager	(Inherited from BaseJobElement)
	DirtyFlagLocker	The lock object for property modification. (Inherited from BaseJobElement)
	DoHandleConditionPortChangedDelegate	(Inherited from BaseJobElement)
	Executions	The number of times this job element should be executed. (Inherited from BaseOnHardwareAutomationT)
	IsDirty	The flag to indicate whether the content of this job element has been modified. (Inherited from BaseJobElement)
	JobElementID	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)
	LogDirectory	The directory of the log file. (Inherited from BasePlugin)
	Logger	The common logger. (Inherited from BasePlugin)
	PluginMetadata	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)
	PortName	The name of the serial port.
	PortValues	The values to write to the port.
	PropertyMask	(Inherited from BaseJobElement)
	ScanControllerAutomationFeatureType	The type of the automation that can be run on the scan controller. (Inherited from BaseOnHardwareAutomationT)
	ShouldExecute	The flag to indicate whether the job element should be marked. (Inherited from BaseAutomationJobElement)
	ShowConditionControllerUIDelegate	The delegate to show the controller UI because no ports have been defined. (Inherited from BaseJobElement)
	VariableManager	(Inherited from BaseJobElement)
	VariableScopeName	(Inherited from BaseJobElement)

Top

Methods

	Name	Description
	CompareWith	(Inherited from BaseJobElement)
	CopyFrom	Copies the source job element into this job element. (Inherited from BaseJobElement)
	Dispose	(Inherited from BasePlugin)
	Dispose(Boolean)	(Inherited from BasePlugin)
	DisposeUI	(Inherited from BaseJobElement)
	DoCompareWith	(Inherited from BaseJobElement)
	DoDisposeUI	(Inherited from BasePlugin)
	DoGetUIMask	(Inherited from BaseJobElement)
	DoShowUI(String)	(Inherited from BaseJobElement)
	DoShowUI(JobElementHolder, String)	(Inherited from BaseJobElement)
	DoShowUI(JobElementHolder, String, PropertyMask)	(Inherited from BaseJobElement)
	DoShowUICallback(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)
	DoShowUICallback(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. (Inherited from BaseJobElement)
	Execute(JobElementHolder)	Executes the automation and return the result. (Inherited from BaseAutomationJobElementT)
	Execute(JobElementHolder, NullableGuid)	Executes the automation and return the result. (Inherited from BaseOnHardwareAutomationT)
	Execute(JobElementHolder, IOPortCondition, NullableGuid)	Executes the automation and return the result. (Inherited from BaseOnHardwareAutomationT)
	GenerateLocalTag	(Inherited from BaseJobElement)
	GetUIMask	(Inherited from BaseJobElement)
	HandleConditionPortChanged	Performs necessary adjustments whenever the controller has updated its ports. (Inherited from BaseJobElement)
	Initialize	Plug-in specific initialization can be done here if necessary. (Inherited from BasePlugin)
	ShowUI(String)	(Inherited from BaseJobElement)
	ShowUI(JobElementHolder, String)	(Inherited from BaseJobElement)
	ShowUI(JobElementHolder, String, PropertyMask)	(Inherited from BaseAutomationJobElementT)
	ShowUICallback(PluginSettingsView)	(Inherited from BaseJobElement)
	ShowUICallback(JobElementHolder, PluginSettingsView)	(Inherited from BaseAutomationJobElementT)
	ShowUICancelCallback(PluginSettingsView)	Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button (Inherited from BasePlugin)
	ShowUICancelCallback(JobElementHolder, PluginSettingsView)	(Inherited from BaseJobElement)
	ToString	(Inherited from BasePlugin)
	UpdateFieldT	Updates the Property to the value by using DirtyFlagLocker and setting IsDirty . (Inherited from BaseJobElement)

Top

Reference

RAYLASE.Marker.JobElement Namespace