DeviceParameterDescriptor Class

Namespace: id3.Devices

Definition

Enhances the basic DeviceParameter with additional details that describe the parameter’s expected behavior, allowable values, and how it interacts with the device’s capabilities.

It’s designed to provide a full specification for a device parameter, aiding in both validation and UI generation for device configuration.

Python

class DeviceParameterDescriptor

Dart

class DeviceParameterDescriptor implements Finalizable

C#

public partial class DeviceParameterDescriptor

Java

public class DeviceParameterDescriptor implements AutoCloseable, Serializable

C

typedef struct id3DevicesDeviceParameterDescriptor *ID3_DEVICES_DEVICE_PARAMETER_DESCRIPTOR;

Usage

Python

deviceParameterDescriptorInstance = DeviceParameterDescriptor()
# ...

Explicit destruction

# ...
del deviceParameterDescriptorInstance

Dart

final deviceParameterDescriptorInstance = sdk.DeviceParameterDescriptor();
// ...

Explicit destruction

// ...
deviceParameterDescriptorInstance.dispose()

C#

using (var deviceParameterDescriptorInstance = new DeviceParameterDescriptor())
{
   // ...
}

Explicit destruction

var deviceParameterDescriptorInstance = new DeviceParameterDescriptor()
// ...
deviceParameterDescriptorInstance.Dispose()

Java

try (DeviceParameterDescriptor deviceParameterDescriptorInstance = new DeviceParameterDescriptor()) {
// ...
}

Explicit destruction

DeviceParameterDescriptor deviceParameterDescriptorInstance = new DeviceParameterDescriptor();
// ...
deviceParameterDescriptorInstance.close();

C

ID3_DEVICES_DEVICE_PARAMETER_DESCRIPTOR hDeviceParameterDescriptor{};
int err = id3DevicesDeviceParameterDescriptor_Initialize(&hDeviceParameterDescriptor);
if (err == ID3_SUCCESS) {
    // ...
    id3DevicesDeviceParameterDescriptor_Dispose(&hDeviceParameterDescriptor);
}

Properties

Name	Type	Description
automatic	bool	A boolean flag indicating whether the parameter is managed automatically by the device or system, or if it requires manual configuration.
category	string	Classifies the parameter into a category, aiding in the organization and presentation of parameters, especially in user interfaces where parameters are grouped by functionality or context.
defaultValue	int	Specifies the default value for the parameter when its type is an integer
flagCapability	ParameterFlagCapability	Indicates whether the parameter is intended for manual configuration by the user (manual) or if it supports automatic management by the device or system (automatic).
multiplicator	int	A factor by which integer parameter values are multiplied, providing a mechanism to adjust the parameter’s scale
parameterName	string	Stores the name of the parameter, serving as a unique identifier within the context of the device
parameterType	ParameterType	Indicates the data type of the parameter (e.g., integer, string, boolean), allowing applications to understand and appropriately handle the parameter’s value.
range	DeviceParameterRange	Defines the allowable range of values for the parameter when its type is an integer
stringList	DeviceParameterList	Provides a list of permissible string values for the parameter when its type allows for selection from a predefined list
valueAsInt	int	Represents the parameter’s value when the parameter type is an integer
valueAsString	string	Holds the parameter’s value for types that are best represented as strings, including textual configurations or numerical values requiring special formatting.

Methods

Name	Description
clear	Resets the parameter’s state, clearing its name, type, and value
getParameterNameString	(C++) Provides low-level access to the internal string representation of the parameter’s name.