Base |
This class is the base class of all kinds of illumination controllers.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.DeviceBaseDeviceController
RAYLASE.Marker.Device.IlluminationControllerBaseIlluminationController
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.DeviceBaseDeviceController
RAYLASE.Marker.Device.IlluminationControllerBaseIlluminationController
Namespace: RAYLASE.Marker.Device.IlluminationController
Assembly: RAYLASE.Marker.Device (in RAYLASE.Marker.Device.dll) Version: 2.19.0
SyntaxC#
public abstract class BaseIlluminationController : BaseDeviceController
The BaseIlluminationController type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BaseIlluminationController | Constructor. |
Properties| Name | Description | |
|---|---|---|
 | ActivatedChainableFeatures |
Gets the activated chainable features.
(Inherited from BaseDeviceController) |
 | ConfigurationManager | (Inherited from BasePlugin) |
| ControllerDisplayName | ControllerDisplayName is a user friendly name |
| ControllerID | The ID to identify the controller in a list of available controllers. |
| EnableChainableFeature |
Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController) |
| HasConnectedStatus |
Is true if the device supports the IsConnected status.
(Overrides BaseDeviceControllerHasConnectedStatus) |
| IsAutoConnect | (Inherited from BaseDeviceController) |
| IsConnected |
Is true if the device is connected.
(Inherited from BaseDeviceController) |
| IsInitialized |
Is true if the device is initialized.
(Inherited from BaseDeviceController) |
| 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) |
| SerialNumber |
Serial number of the device.
(Inherited from BaseDeviceController) |
| Statuses | (Inherited from BaseDeviceController) |
| SupportedChainableFeatureMap |
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) |
Methods| Name | Description | |
|---|---|---|
 | Connect |
Connects to the device.
(Inherited from BaseDeviceController) |
| Disconnect |
Disconnects from the device.
(Inherited from BaseDeviceController) |
| Dispose | (Inherited from BasePlugin) |
| Dispose(Boolean) | (Inherited from BaseDeviceController) |
| DisposeUI |
Disposes the given setting view.
(Inherited from BaseDeviceController) |
| DoDisposeUI | (Inherited from BasePlugin) |
| DoShowUI |
Shows the specific UI embedded in the plug-in instance. The content will be wrapped by a preset view.
(Inherited from BasePlugin) |
| DoShowUICallback |
Invokes the callback that can be used when the DoShowUI method is done.
(Inherited from BasePlugin) |
| GetDeviceStatusRepresentation |
Returns the color and description of device state. Useful for UI purpose.
(Inherited from BaseDeviceController) |
| HandleExternalDeviceRequestAsync |
Handles a chained request for a given list of features.
(Inherited from BaseDeviceController) |
| Initialize |
Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin) |
| InvokeConnected |
Invokes Connected event.
(Inherited from BaseDeviceController) |
| InvokeDisconnected |
Invokes Disconnected event.
(Inherited from BaseDeviceController) |
| InvokeInitialized |
Invokes Initialized event.
(Inherited from BaseDeviceController) |
| InvokeStatusChanged |
Invokes StatusChanged event.
(Inherited from BaseDeviceController) |
| OnDevicesChanged | (Inherited from BaseDeviceController) |
| ShowUI |
Shows the specific UI embedded in the plugin instance.
(Inherited from BaseDeviceController) |
| ShowUICallback |
Invokes the callback that can be used when the ShowUI method is done.
(Inherited from BaseDeviceController) |
| ShowUICancelCallback |
Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin) |
| ToString | (Inherited from BasePlugin) |
Events| Name | Description | |
|---|---|---|
 | Connected |
An event that is triggered when the device is connected.
(Inherited from BaseDeviceController) |
| Disconnected |
An event that is triggered when the device is disconnected.
(Inherited from BaseDeviceController) |
| Initialized |
An event that is triggered when the device is initialized.
(Inherited from BaseDeviceController) |
| StatusChanged |
An event that is triggered when the status of the device is changed.
(Inherited from BaseDeviceController) |
Fields| Name | Description | |
|---|---|---|
 | IsDirtyEventHandler | An event that is triggered when the device settings changed by user |
See Also