Class DMXDeviceProvider

Represents the abstract base implementation for a IRGBDeviceProvider.

Inheritance
object
AbstractRGBDeviceProvider
DMXDeviceProvider
Implements
Inherited Members
Namespace: RGB.NET.Devices.DMX
Assembly: RGB.NET.Devices.DMX.dll
Syntax
public sealed class DMXDeviceProvider : AbstractRGBDeviceProvider, IRGBDeviceProvider, IDisposable

Constructors

| Edit this page View Source

DMXDeviceProvider()

Initializes a new instance of the DMXDeviceProvider class.

Declaration
public DMXDeviceProvider()
Exceptions
Type Condition
InvalidOperationException

Thrown if this constructor is called even if there is already an instance of this class.

Properties

| Edit this page View Source

DeviceDefinitions

Gets a list of all defined device-definitions.

Declaration
public List<IDMXDeviceDefinition> DeviceDefinitions { get; }
Property Value
Type Description
List<IDMXDeviceDefinition>
| Edit this page View Source

Instance

Gets the singleton DMXDeviceProvider instance.

Declaration
public static DMXDeviceProvider Instance { get; }
Property Value
Type Description
DMXDeviceProvider

Methods

| Edit this page View Source

AddDeviceDefinition(IDMXDeviceDefinition)

Adds the specified IDMXDeviceDefinition to this device-provider.

Declaration
public void AddDeviceDefinition(IDMXDeviceDefinition deviceDefinition)
Parameters
Type Name Description
IDMXDeviceDefinition deviceDefinition

The IDMXDeviceDefinition to add.
| Edit this page View Source

CreateUpdateTrigger(int, double)

Creates a update trigger with the specified id and the specified update rate hard limit.

Declaration
protected override IDeviceUpdateTrigger CreateUpdateTrigger(int id, double updateRateHardLimit)
Parameters
Type Name Description
int id

The id of the update trigger.
double updateRateHardLimit

The update rate hard limit tobe set in the update trigger.
Returns
Type Description
IDeviceUpdateTrigger

The newly created update trigger.
Overrides
| Edit this page View Source

Dispose(bool)

Disposes the object and frees all resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true if explicitely called through the Dispose-Method, false if called by the destructor.
Overrides
| Edit this page View Source

InitializeSDK()

Initializes the underlying SDK.

Declaration
protected override void InitializeSDK()
Overrides
| Edit this page View Source

LoadDevices()

Loads all devices this device provider is capable of loading.

Declaration
protected override IEnumerable<IRGBDevice> LoadDevices()
Returns
Type Description
IEnumerable<IRGBDevice>

A collection of loaded devices.
Overrides
Remarks

Filtering happens in GetLoadedDevices(RGBDeviceType).

Implements