Generic Feature Access (GFA)

Modules
	GFA Float
	GFA Integer
	GFA Boolean
	GFA String
	GFA Command
	GFA Enumeration
	GFA Register
	GFA Data

Enumerations
enum	peak_gfa_module {   PEAK_GFA_MODULE_INVALID, PEAK_GFA_MODULE_SYSTEM, PEAK_GFA_MODULE_INTERFACE, PEAK_GFA_MODULE_LOCAL_DEVICE,   PEAK_GFA_MODULE_REMOTE_DEVICE, PEAK_GFA_MODULE_DATA_STREAM }
	peak GFA modules More...

Functions
peak_status	peak_GFA_EnableWriteAccess (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the GFA write access. More...
peak_bool	peak_GFA_IsWriteAccessEnabled (peak_camera_handle hCam)
	Get the enabled status of the GFA write access. More...
peak_access_status	peak_GFA_Feature_GetAccessStatus (peak_camera_handle hCam, peak_gfa_module module, const char *featureName)
	Query the access status of the feature with the given name. More...

Detailed Description

Generic feature access related functions and types.

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

Enumeration Type Documentation

peak_gfa_module

enum peak_gfa_module

peak GFA modules

The generic feature access module specifies the GenICam module which is addressed in a generic feature access function call.

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

Enumerator
PEAK_GFA_MODULE_INVALID	Invalid GFA module. Use this value for the initialization of variables of type peak_gfa_module.
PEAK_GFA_MODULE_SYSTEM	The GFA module for the access of the GenICam GenTL System module.
PEAK_GFA_MODULE_INTERFACE	The GFA module for the access of the GenICam GenTL Interface module.
PEAK_GFA_MODULE_LOCAL_DEVICE	The GFA module for the access of the GenICam GenTL Local Device module.
PEAK_GFA_MODULE_REMOTE_DEVICE	The GFA module for the access of the GenICam Remote Device module.
PEAK_GFA_MODULE_DATA_STREAM	The GFA module for the access of the GenICam GenTL Data Stream module.

Function Documentation

peak_GFA_EnableWriteAccess()

peak_status peak_GFA_EnableWriteAccess	(	peak_camera_handle	hCam,
		peak_bool	enabled
	)

Enable/Disable the GFA write access.

Sets the GFA write access to enabled or disabled.

The GFA write access is a specific mode of operation of the library.
While the library is in GFA write access mode all calls to the convenience interface, i.e. to the non-GFA functions of the library, are rejected.
The GFA write access mode can be set to enabled only

• if there is no running call to a convenience interface function, and
• if there is no running acquisition, and
• if it is not enabled already.

Note

A write access via the GFA interface is only allowed when the GFA write access is enabled.

The use of the convenience interface is only allowed when the GFA write access is disabled.

Parameters

[in]	hCam	The camera handle.
[in]	enabled	The desired enabled status. PEAK_TRUE for enabled, PEAK_FALSE for disabled.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The desired GFA write access can not be set.
For enabled == PEAK_TRUE

• Make sure there is no running call to a convenience interface function.
• Check for the GFA write access to be enabled already via peak_GFA_IsWriteAccessEnabled.

For enabled == PEAK_FALSE

• Check for the GFA write access to be disabled already via peak_GFA_IsWriteAccessEnabled.

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).

peak_GFA_Feature_GetAccessStatus()

peak_access_status peak_GFA_Feature_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	featureName
	)

Query the access status of the feature with the given name.

Provides the current access status of the specified feature for the specified module.

This function implements the Access Status Query principle.

Parameters

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

Returns

PEAK_ACCESS_READWRITE The feature is readable and writeable.

PEAK_ACCESS_READONLY The feature is readable only.

PEAK_ACCESS_WRITEONLY The feature is writeable only.

PEAK_ACCESS_NONE The feature is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The feature is not supported.

PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

Note

Consider that a write access can only be available in the GFA write access mode. See peak_GFA_EnableWriteAccess.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

• PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.
• PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module. Check peak_gfa_module.
• 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).

peak_GFA_IsWriteAccessEnabled()

peak_bool peak_GFA_IsWriteAccessEnabled

(

peak_camera_handle

hCam

)

Get the enabled status of the GFA write access.

Queries whether the GFA write access is currently enabled or disabled.

This function implements the Enabled Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_TRUE The GFA write access is currently enabled.

PEAK_FALSE The GFA write access is currently disabled or the query failed.

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