class OptionInformation

August 13, 2019 ยท View on GitHub

Member values

Member nameData typeDescription
sensoruint32The sensor (color or depth)
optionuint32The option
supportedboolIs the option supported by the chosen sensor?
read_onlyboolIs the option read-only, or can it be changed?
minimumfloat32Minimum value for the option
maximumfloat32Maximum value for the option
stepfloat32Step size for the option value (if it takes on discrete values)
default_valuefloat32Default value for the option

Member functions

Function nameReturn typeInput typeDescription
sensor() constuint32voidReturns the current value of sensor. If the sensor is not set, returns 0.
set_sensor()voiduint32Sets the value of sensor. After calling this, sensor() will return value.
clear_sensor()voidvoidClears the value of sensor. After calling this, sensor() will return the empty string/empty bytes.
option() constuint32voidReturns the current value of option. If the option is not set, returns 0.
set_option()voiduint32Sets the value of option. After calling this, option() will return value.
clear_option()voidvoidClears the value of option. After calling this, option() will return the empty string/empty bytes.
supported()boolvoidReturns the current value of supported. If the supported is not set, returns 0.
set_supported()voidboolSets the value of supported. After calling this, supported() will return value.
clear_supported()voidvoidClears the value of supported. After calling this, supported() will return 0.
read_only()boolvoidReturns the current value of read_only. If the read_only is not set, returns 0.
set_read_only()voidboolSets the value of read_only. After calling this, read_only() will return value.
clear_read_only()voidvoidClears the value of read_only. After calling this, read_only() will return 0.
minimum()float32voidReturns the current value of minimum. If the minimum is not set, returns 0.
set_minimum()voidfloat32Sets the value of minimum. After calling this, minimum() will return value.
clear_minimum()voidvoidClears the value of minimum. After calling this, minimum() will return 0.
maximum()float32voidReturns the current value of maximum. If the maximum is not set, returns 0.
set_maximum()voidfloat32Sets the value of maximum. After calling this, maximum() will return value.
clear_maximum()voidvoidClears the value of maximum. After calling this, maximum() will return 0.
step()float32voidReturns the current value of step. If the step is not set, returns 0.
set_step()voidfloat32Sets the value of step. After calling this, step() will return value.
clear_step()voidvoidClears the value of step. After calling this, step() will return 0.
default_value()float32voidReturns the current value of default_value. If the default_value is not set, returns 0.
set_default_value()voidfloat32Sets the value of default_value. After calling this, default_value() will return value.
clear_default_value()voidvoidClears the value of default_value. After calling this, default_value() will return 0.

Parent topic: VisionConfig (C++)