Data Fields
OScDev_Error(*	GetBool )(OScDev_Setting setting, bool value)

OScDev_Error(*	GetEnum )(OScDev_Setting setting, uint32_t value)

OScDev_Error(*	GetEnumNameForValue )(OScDev_Setting setting, uint32_t value, char name)

OScDev_Error(*	GetEnumNumValues )(OScDev_Setting setting, uint32_t count)

OScDev_Error(*	GetEnumValueForName )(OScDev_Setting setting, uint32_t value, const char *name)

OScDev_Error(*	GetFloat64 )(OScDev_Setting setting, double value)

OScDev_Error(*	GetFloat64DiscreteValues )(OScDev_Setting setting, OScDev_NumArray *values)
	Get the allowed values of an float64 setting with discrete values constraint. More...

OScDev_Error(*	GetFloat64Range )(OScDev_Setting setting, double min, double *max)
	Get the range of an float64 setting with range constraint. More...

OScDev_Error(*	GetInt32 )(OScDev_Setting setting, int32_t value)

OScDev_Error(*	GetInt32DiscreteValues )(OScDev_Setting setting, OScDev_NumArray *values)
	Get the allowed values of an int32 setting with discrete values constraint. More...

OScDev_Error(*	GetInt32Range )(OScDev_Setting setting, int32_t min, int32_t *max)
	Get the range of an int32 setting with range constraint. More...

OScDev_Error(*	GetNumericConstraintType )(OScDev_Setting setting, OScDev_ValueConstraint constraintType)
	Get the type of value constraint of an int32 or float64 setting. More...

OScDev_Error(*	GetString )(OScDev_Setting setting, char value)

OScDev_Error(*	IsEnabled )(OScDev_Setting setting, bool enabled)

OScDev_Error(*	IsWritable )(OScDev_Setting setting, bool writable)

void(*	Release )(OScDev_Setting *setting)
	Free the private data associated with a setting, if any.

OScDev_Error(*	SetBool )(OScDev_Setting *setting, bool value)

OScDev_Error(*	SetEnum )(OScDev_Setting *setting, uint32_t value)

OScDev_Error(*	SetFloat64 )(OScDev_Setting *setting, double value)

OScDev_Error(*	SetInt32 )(OScDev_Setting *setting, int32_t value)

OScDev_Error(*	SetString )(OScDev_Setting setting, const char value)

Detailed Description

Definition at line 831 of file OpenScanDeviceLib.h.

Field Documentation

◆ GetNumericConstraintType

OScDev_Error(* GetNumericConstraintType) (OScDev_Setting *setting, OScDev_ValueConstraint *constraintType)

Get the type of value constraint of an int32 or float64 setting.

Todo:: We cannot realistically allow the constraint type to change, so this should be a static data field.

Definition at line 852 of file OpenScanDeviceLib.h.

◆ GetInt32Range

OScDev_Error(* GetInt32Range) (OScDev_Setting *setting, int32_t *min, int32_t *max)

Get the range of an int32 setting with range constraint.

Required if value type is int32 and numeric constraint type is range.

Precondition: setting, min, and max are guaranteed to be valid pointers.

Definition at line 869 of file OpenScanDeviceLib.h.

◆ GetInt32DiscreteValues

OScDev_Error(* GetInt32DiscreteValues) (OScDev_Setting *setting, OScDev_NumArray **values)

Get the allowed values of an int32 setting with discrete values constraint.

Required if value type is int32 and numeric constraint type is discrete values.

Precondition: setting and values are guaranteed to be valid pointers.

The implementation must create a new OScDev_NumArray and set *values to its address.

Parameters

	setting	the setting
[out]	values	address where implementation should write pointer to new array containing allowed values (which must fit in int32) for the setting

Returns: error in case hardware need to be queried and query failed

Definition at line 890 of file OpenScanDeviceLib.h.

◆ GetFloat64Range

OScDev_Error(* GetFloat64Range) (OScDev_Setting *setting, double *min, double *max)

Get the range of an float64 setting with range constraint.

Required if value type is float64 and numeric constraint type is range.

Precondition: setting, min, and max are guaranteed to be valid pointers.

Definition at line 904 of file OpenScanDeviceLib.h.

◆ GetFloat64DiscreteValues

OScDev_Error(* GetFloat64DiscreteValues) (OScDev_Setting *setting, OScDev_NumArray **values)

Get the allowed values of an float64 setting with discrete values constraint.

Required if value type is float64 and numeric constraint type is discrete values.

Precondition: setting and values are guaranteed to be valid pointers.