Functions
peak_bool	peak_GFA_Float_HasRange (peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName)
	Check whether the valid values for the float feature with the given name are organized as a range.
peak_status	peak_GFA_Float_GetRange (peak_camera_handle hCam, peak_gfa_module module, const char floatFeatureName, double minFloatValue, double maxFloatValue, double incFloatValue)
	Get the current range of valid values for the float feature with the given name.
peak_status	peak_GFA_Float_GetList (peak_camera_handle hCam, peak_gfa_module module, const char floatFeatureName, double floatList, size_t *floatCount)
	Get the list of currently selectable values for the float feature with the given name.
peak_status	peak_GFA_Float_Set (peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName, double floatValue)
	Set the float feature with the given name.
peak_status	peak_GFA_Float_Get (peak_camera_handle hCam, peak_gfa_module module, const char floatFeatureName, double floatValue)
	Get the float feature with the given name.

Detailed Description

Generic float feature access related functions and types.

Function Documentation

◆ peak_GFA_Float_Get()

peak_status peak_GFA_Float_Get	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	floatFeatureName,
		double *	floatValue )

Get the float feature with the given name.

Reads the current value of the float feature with the given name.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	floatFeatureName	The name of the float feature as a zero-terminated string.
[out]	floatValue	The value of the float feature.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The float feature is not available for read access. Check the access status via peak_GFA_Feature_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or floatFeatureName and/or floatValue are invalid pointers or floatFeatureName is not zero-terminated. Check peak_gfa_module.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

For a description of the generic feature access concept see Generic Feature Access (GFA).

Since: 1.0

◆ peak_GFA_Float_GetList()

peak_status peak_GFA_Float_GetList	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	floatFeatureName,
		double *	floatList,
		size_t *	floatCount )

Get the list of currently selectable values for the float feature with the given name.

Queries the list of currently selectable values for the float feature with the given name.

The list of selectable float values may depend on the camera configuration and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	floatFeatureName	The name of the float feature as a zero-terminated string.
[out]	floatList	Pointer to a user allocated array buffer to receive the float value list. If this parameter is NULL, `floatCount` will contain the current number of float values. The required size of `floatList` in bytes is `floatCount` x sizeof(double).
[in,out]	floatCount	`floatList` equal NULL: out: minimal number of float values `floatList` must be large enough to hold `floatList` unequal NULL: in: number of float values `floatList` can hold out: number of float values filled by the function

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_NO_DATA The valid values for the float feature are organized as range rather than as a list.
Use peak_GFA_Float_GetRange to query the valid float values.; PEAK_STATUS_BUFFER_TOO_SMALL floatList is not NULL and the value of *floatCount is too small to receive the expected amount of data.; PEAK_STATUS_ACCESS_DENIED The float feature is not accessible. Check the access status via peak_GFA_Feature_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or floatFeatureName and/or floatCount are invalid pointers or floatFeatureName is not zero-terminated. Check peak_gfa_module.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Note: Consider that the float value list might change between the size query call and the list query call.
This may be the case if the camera configuration or the camera status have changed in the time between the two function calls.

Since: 1.0

◆ peak_GFA_Float_GetRange()

peak_status peak_GFA_Float_GetRange	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	floatFeatureName,
		double *	minFloatValue,
		double *	maxFloatValue,
		double *	incFloatValue )

Get the current range of valid values for the float feature with the given name.

Queries the current range of valid values for the float feature with the given name.

The range of valid values for the float feature with the given name may depend on the camera configuration and the camera status.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	floatFeatureName	The name of the float feature as a zero-terminated string.
[out]	minFloatValue	The minimum value for the float feature.
[out]	maxFloatValue	The maximum value for the float feature.
[out]	incFloatValue	The increment for the float feature.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_NO_DATA The valid values for the float feature are organized as list rather than as a range.
Use peak_GFA_Float_GetList to query the valid float values.; PEAK_STATUS_ACCESS_DENIED The float feature is not accessible. Check the access status via peak_GFA_Feature_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or at least one of floatFeatureName, minFloatValue, maxFloatValue, and incFloatValue is an invalid pointer or floatFeatureName is not zero-terminated. Check peak_gfa_module.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

For a description of the generic feature access concept see Generic Feature Access (GFA).

Since: 1.0

◆ peak_GFA_Float_HasRange()

peak_bool peak_GFA_Float_HasRange	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	floatFeatureName )

Check whether the valid values for the float feature with the given name are organized as a range.

Checks whether the valid values for the float feature with the given name are organized as a range or as a list.

This function implements the Valid Values Organization Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	floatFeatureName	The name of the float feature as a zero-terminated string.

Returns: PEAK_TRUE The valid values are organized as a range. Use peak_GFA_Float_GetRange.; PEAK_FALSE The valid values are organized as a list. Use peak_GFA_Float_GetList.

Since: 1.0

◆ peak_GFA_Float_Set()

peak_status peak_GFA_Float_Set	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	floatFeatureName,
		double	floatValue )

Set the float feature with the given name.

Writes the desired value to the float feature with the given name.

Note: The write access is only available in the GFA write access mode. See peak_GFA_EnableWriteAccess.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	floatFeatureName	The name of the float feature as a zero-terminated string.
[in]	floatValue	The float value to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_OUT_OF_RANGE floatValue is out of range. Check the range of valid values via peak_GFA_Float_GetRange or peak_GFA_Float_GetList.; PEAK_STATUS_ACCESS_DENIED The float feature is not available for write access. Check the access status via peak_GFA_Feature_GetAccessStatus. Check for the GFA write access mode to be enabled via peak_GFA_IsWriteAccessEnabled.; PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or floatFeatureName is an invalid pointer or it is not zero-terminated. Check peak_gfa_module.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

For a description of the generic feature access concept see Generic Feature Access (GFA).

Since: 1.0

Functions

Detailed Description

Function Documentation

◆ peak_GFA_Float_Get()

◆ peak_GFA_Float_GetList()

◆ peak_GFA_Float_GetRange()

◆ peak_GFA_Float_HasRange()

◆ peak_GFA_Float_Set()