Click or drag to resize

SPICE3SerialController Class

Provides serial communication functionalities to SP-ICE-3 card.
Inheritance Hierarchy
SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.DeviceBaseDeviceController
      RAYLASE.Marker.Device.SerialControllerBaseSerialController
        RAYLASE.MarkerPlugin.Devices.ScanController.SPICE3SPICE3SerialController

Namespace: RAYLASE.MarkerPlugin.Devices.ScanController.SPICE3
Assembly: RAYLASE.MarkerPlugin (in RAYLASE.MarkerPlugin.dll) Version: 2.19.0
Syntax
C#
public class SPICE3SerialController : BaseSerialController

The SPICE3SerialController type exposes the following members.

Constructors
 NameDescription
Public methodSPICE3SerialController ctor
Top
Properties
 NameDescription
Public propertyActivatedChainableFeatures Gets the activated chainable features.
(Inherited from BaseDeviceController)
Public propertyAutomationFeatureSet The types of automation that this controller can process as command lists in a scan controller.
(Inherited from BaseSerialController)
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Public propertyEnableChainableFeature Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController)
Public propertyHasConnectedStatus Is true if the device supports the IsConnected status.
(Inherited from BaseDeviceController)
Public propertyIsAutoConnect
(Inherited from BaseDeviceController)
Public propertyIsConnected Is true if the device is connected.
(Inherited from BaseDeviceController)
Public propertyIsInitialized Is true if the device is initialized.
(Inherited from BaseDeviceController)
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 propertyPort The internal serial port.
Public propertyPorts
(Overrides BaseSerialControllerPorts)
Public propertySerialNumber Serial number of the device.
(Inherited from BaseDeviceController)
Public propertySetSerialConfigDelegate Gets or sets the set serial config delegate.
(Inherited from BaseSerialController)
Public propertyStatuses
(Inherited from BaseDeviceController)
Public propertySupportedChainableFeatureMap The map of chainable feature types supported by this device. The value indicates whether the feature is a transmitter or a receiver.
(Inherited from BaseDeviceController)
Public propertyWriteLineBinaryDelegate The write port delegate.
(Inherited from BaseSerialController)
Public propertyWriteLineTextDelegate The write port delegate.
(Inherited from BaseSerialController)
Top
Methods
 NameDescription
Public methodConnect Connects to the device.
(Overrides BaseDeviceControllerConnect)
Public methodDisconnect Disconnects from the device.
(Overrides BaseDeviceControllerDisconnect)
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean)
(Inherited from BaseDeviceController)
Public methodDisposeUI Disposes the given setting view.
(Inherited from BaseDeviceController)
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.
(Overrides BasePluginDoShowUI(String))
Protected methodDoShowUICallback Invokes the callback that can be used when the DoShowUI method is done.
(Overrides BasePluginDoShowUICallback(PluginSettingsView))
Public methodGetDeviceStatusRepresentation Returns the color and description of device state. Useful for UI purpose.
(Inherited from BaseDeviceController)
Public methodHandleExternalDeviceRequestAsync Handles a chained request for a given list of features.
(Overrides BaseDeviceControllerHandleExternalDeviceRequestAsync(IListTupleChainableFeatureType, ExpandoObject, CancellationToken))
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Overrides BasePluginInitialize)
Protected methodInvokeConnected Invokes Connected event.
(Inherited from BaseDeviceController)
Protected methodInvokeDisconnected Invokes Disconnected event.
(Inherited from BaseDeviceController)
Protected methodInvokeInitialized Invokes Initialized event.
(Inherited from BaseDeviceController)
Protected methodInvokeStatusChanged Invokes StatusChanged event.
(Inherited from BaseDeviceController)
Protected methodOnDevicesChanged
(Inherited from BaseDeviceController)
Public methodSetSerialConfig Sends the serial configuration to the hardware.
(Inherited from BaseSerialController)
Public methodShowUI Shows the specific UI embedded in the plugin instance.
(Inherited from BaseDeviceController)
Public methodShowUICallback Invokes the callback that can be used when the ShowUI method is done.
(Inherited from BaseDeviceController)
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)
Public methodWritePort(String, IListSerialPortBinaryData, Int32, IOPortCondition, NullableGuid) Writes a sequence of binary data to a given port.
(Overrides BaseSerialControllerWritePort(String, IListSerialPortBinaryData, Int32, IOPortCondition, NullableGuid))
Public methodWritePort(String, IListSerialPortTextData, Int32, IOPortCondition, NullableGuid) Writes a sequence of text data to a given port.
(Overrides BaseSerialControllerWritePort(String, IListSerialPortTextData, Int32, IOPortCondition, NullableGuid))
Top
Events
 NameDescription
Public eventConnected An event that is triggered when the device is connected.
(Inherited from BaseDeviceController)
Public eventDisconnected An event that is triggered when the device is disconnected.
(Inherited from BaseDeviceController)
Public eventInitialized An event that is triggered when the device is initialized.
(Inherited from BaseDeviceController)
Public eventStatusChanged An event that is triggered when the status of the device is changed.
(Inherited from BaseDeviceController)
Top
See Also