Base |
Represents the base class of all plugins of type on-hardware wait-for-external-start automation job elements. An on-hardware automation job element will perform its automation as a command on the scan controller.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseAutomationJobElement
RAYLASE.Marker.JobElementBaseAutomationJobElementValueTupleGuid, Boolean
RAYLASE.Marker.JobElementBaseOnHardwareAutomationValueTupleGuid, Boolean
RAYLASE.Marker.JobElementBasePortAutomationValueTupleGuid, Boolean
RAYLASE.Marker.JobElementBaseWaitPortAutomation
RAYLASE.MarkerPlugin.JobElementsWaitPortAutomation
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseAutomationJobElement
RAYLASE.Marker.JobElementBaseAutomationJobElementValueTupleGuid, Boolean
RAYLASE.Marker.JobElementBaseOnHardwareAutomationValueTupleGuid, Boolean
RAYLASE.Marker.JobElementBasePortAutomationValueTupleGuid, Boolean
RAYLASE.Marker.JobElementBaseWaitPortAutomation
RAYLASE.MarkerPlugin.JobElementsWaitPortAutomation
Namespace: RAYLASE.Marker.JobElement
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.30.0
SyntaxC#
public abstract class BaseWaitPortAutomation : BasePortAutomation<(Guid , bool )>
The BaseWaitPortAutomation type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BaseWaitPortAutomation | Initializes a new instance of the Object class. |
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 IO controller to be used.
(Inherited from BasePortAutomationT) |
| DeviceManager | (Inherited from BaseJobElement) |
| DirtyFlagLocker |
The lock object for property modification.
(Inherited from BaseJobElement) |
| DoHandleConditionPortChangedDelegate | (Inherited from BaseJobElement) |
| DoHandlePortChangedDelegate | (Inherited from BasePortAutomationT) |
| 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) |
| PortDefinition |
The logical definition of the port.
(Inherited from BasePortAutomationT) |
| PortValue | The expected value to wait from 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) |
| ShowControllerUIDelegate |
The delegate to show the controller UI because no port has been defined.
(Inherited from BasePortAutomationT) |
| Timeout |
The period to wait until it expires. If expires, the execution process should skip the scope of this job element. The value of less than 1 means to wait indefinitely. |
| VariableManager | (Inherited from BaseJobElement) |
| VariableScopeName | (Inherited from BaseJobElement) |
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) |
| HandlePortChanged |
Performs necessary adjustments whenever the controller has updated its ports.
(Inherited from BasePortAutomationT) |
| 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) |
| ValidatePort |
Validates whether the port definition is defined in the IO controller.
(Inherited from BasePortAutomationT) |
See Also