Class DeviceTypeRegistrationOptions

Namespace

Acuit.Pinpoint.IO

Assembly

Acuit.Pinpoint.IO.Abstractions.dll

Device type registration options.

public class DeviceTypeRegistrationOptions

Inheritance

object

DeviceTypeRegistrationOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

DeviceTypeRegistrationOptions(IConfiguredDeviceEnumerator)

Initializes a new instance of the DeviceTypeRegistrationOptions class.

public DeviceTypeRegistrationOptions(IConfiguredDeviceEnumerator configuredDeviceEnumerator)

Parameters

configuredDeviceEnumerator IConfiguredDeviceEnumerator

The enumerator for configured devices.

Exceptions

ArgumentNullException

configuredDeviceEnumerator is null.

DeviceTypeRegistrationOptions(IConfiguredDeviceEnumerator, IConfigurationSection)

Initializes a new instance of the DeviceTypeRegistrationOptions class.

public DeviceTypeRegistrationOptions(IConfiguredDeviceEnumerator configuredDeviceEnumerator, IConfigurationSection configurationSection)

Parameters

configuredDeviceEnumerator IConfiguredDeviceEnumerator

The enumerator for configured devices.

configurationSection IConfigurationSection

The configuration section containing settings for the device type.

Exceptions

ArgumentNullException

configuredDeviceEnumerator is null.

- or -

configurationSection is null.

Properties

Addressable

Gets or sets whether this registration is for devices that must be addressable, either by name when there are multiple, or as the single device of this type. This defaults to false.

public bool Addressable { get; set; }

Property Value

bool

Remarks

When this is true, these devices are meant to be accessed via GetDevice(Type, string), so any that are not accessible will cause a health problem to be raised. Devices are inaccessible when they are not the first device configured and they do not have a unique name.

Addressable devices are typically accessed via workflow activities, such as the PrintLabel activity, which indicate which device to use.

Non-addressable devices are typically background devices that operate independently, such as bar code scanners.

ConfigurationSection

Gets or sets the configuration section containing settings for the device type, or null if the device type is not configured via configuration settings.

public IConfigurationSection ConfigurationSection { get; set; }

Property Value

IConfigurationSection

ConfiguredDeviceEnumerator

Gets the enumerator for configured devices.

public IConfiguredDeviceEnumerator ConfiguredDeviceEnumerator { get; }

Property Value

IConfiguredDeviceEnumerator

HealthCheckName

Gets or sets the name to use in device health check names.

public string HealthCheckName { get; set; }

Property Value

string

Remarks

If this is null or empty, then the short name (i.e., without its namespace) of the device type Type will be used.

Services

Gets the collection of device services available for this device type.

public ICollection<DeviceTypeService> Services { get; }

Property Value

ICollection<DeviceTypeService>