OScDev_SettingImpl Struct Reference

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.
OScDev_Error(*	GetFloat64Range )(OScDev_Setting *setting, double *min, double *max)
	Get the range of an float64 setting with range constraint.
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.
OScDev_Error(*	GetInt32Range )(OScDev_Setting *setting, int32_t *min, int32_t *max)
	Get the range of an int32 setting with range constraint.
OScDev_Error(*	GetNumericConstraintType )(OScDev_Setting *setting, OScDev_ValueConstraint *constraintType)
	Get the type of value constraint of an int32 or float64 setting.
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 882 of file OpenScanDeviceLib.h.

Field Documentation

IsEnabled

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

Definition at line 894 of file OpenScanDeviceLib.h.

IsWritable

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

Definition at line 895 of file OpenScanDeviceLib.h.

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 903 of file OpenScanDeviceLib.h.

GetString

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

Definition at line 905 of file OpenScanDeviceLib.h.

SetString

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

Definition at line 906 of file OpenScanDeviceLib.h.

GetBool

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

Definition at line 907 of file OpenScanDeviceLib.h.

SetBool

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

Definition at line 908 of file OpenScanDeviceLib.h.

GetInt32

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

Definition at line 909 of file OpenScanDeviceLib.h.

SetInt32

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

Definition at line 910 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 920 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 941 of file OpenScanDeviceLib.h.

GetFloat64

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

Definition at line 944 of file OpenScanDeviceLib.h.

SetFloat64

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

Definition at line 945 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 955 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.

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 for the setting

Returns

error in case hardware need to be queried and query failed

Definition at line 975 of file OpenScanDeviceLib.h.

GetEnum

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

Definition at line 977 of file OpenScanDeviceLib.h.

SetEnum

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

Definition at line 978 of file OpenScanDeviceLib.h.

GetEnumNumValues

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

Definition at line 979 of file OpenScanDeviceLib.h.

GetEnumNameForValue

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

Definition at line 980 of file OpenScanDeviceLib.h.

GetEnumValueForName

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

Definition at line 982 of file OpenScanDeviceLib.h.

Release

void(* Release) (OScDev_Setting *setting)

Free the private data associated with a setting, if any.

Definition at line 986 of file OpenScanDeviceLib.h.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/OpenScanLib/OpenScanLib/OpenScanDeviceLib/include/OpenScanDeviceLib.h