DeviceParameter Class

Namespace: id3.Devices

Definition

Centralizes information related to a single device parameter, including its name, type, value, and mode of operation (automatic or manual).
It serves as a flexible structure for representing device configurations, enabling applications to interact with and manipulate device settings in a consistent and type-safe manner.

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.

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.

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.