Click or drag to resize

BaseDeviceController Class

Represents the base class for all plugins of type devices.
Inheritance Hierarchy
SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.DeviceBaseDeviceController
      More

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

The BaseDeviceController type exposes the following members.

Constructors
 NameDescription
Protected methodBaseDeviceController ctor
Top
Properties
 NameDescription
Public propertyActivatedChainableFeatures Gets the activated chainable features.
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Public propertyEnableChainableFeature Gets or sets the flag to enable chainable features.
Public propertyHasConnectedStatus Is true if the device supports the IsConnected status.
Public propertyIsAutoConnect 
Public propertyIsConnected Is true if the device is connected.
Public propertyIsInitialized Is true if the device is initialized.
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 propertySerialNumber Serial number of the device.
Public propertyStatuses 
Public propertySupportedChainableFeatureMap The map of chainable feature types supported by this device. The value indicates whether the feature is a transmitter or a receiver.
Top
Methods
 NameDescription
Public methodConnect Connects to the device.
Public methodDisconnect Disconnects from the device.
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the BaseDeviceController and optionally releases the managed resources
(Overrides BasePluginDispose(Boolean))
Public methodDisposeUI Disposes the given setting view.
(Overrides BasePluginDisposeUI(PluginSettingsView))
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.
(Inherited from BasePlugin)
Protected methodDoShowUICallback Invokes the callback that can be used when the DoShowUI method is done.
(Inherited from BasePlugin)
Public methodGetDeviceStatusRepresentation Returns the color and description of device state. Useful for UI purpose.
Public methodHandleExternalDeviceRequestAsync Handles a chained request for a given list of features.
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin)
Protected methodInvokeConnected Invokes Connected event.
Protected methodInvokeDisconnected Invokes Disconnected event.
Protected methodInvokeInitialized Invokes Initialized event.
Protected methodInvokeStatusChanged Invokes StatusChanged event.
Protected methodOnDevicesChanged 
Public methodShowUI Shows the specific UI embedded in the plugin instance.
(Overrides BasePluginShowUI(String))
Public methodShowUICallback Invokes the callback that can be used when the ShowUI method is done.
(Overrides BasePluginShowUICallback(PluginSettingsView))
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)
Top
Events
 NameDescription
Public eventConnected An event that is triggered when the device is connected.
Public eventDisconnected An event that is triggered when the device is disconnected.
Public eventInitialized An event that is triggered when the device is initialized.
Public eventStatusChanged An event that is triggered when the status of the device is changed.
Top
See Also
Inheritance Hierarchy