Back to Aurora Vision Library website

You are here: Start » Function Reference » GenICam » GenICam_GetEnumParameter

GenICam_GetEnumParameter


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: Genicam.h
Namespace: avs
Module: Genicam

Gets parameter of type Enumeration from GenICam device.

Syntax

void avs::GenICam_GetEnumParameter
(
	GenICam_GetEnumParameter_State& ioState,
	const avl::GenAddress& inAddress,
	avl::GenICamParameterScope::Type inScope,
	const avl::GenParameterName& inParameterName,
	bool inVerifyAccess,
	atl::String& outValue
)

Parameters

Name Type Default Description
Input will be modified ioState GenICam_GetEnumParameter_State& Object used to maintain state of the function.
Input value inAddress const GenAddress& GenTL Provider module and device identifying address
Input value inScope GenICamParameterScope::Type Specifies which parameters set in GenICam stack should be accessed
Input value inParameterName const GenParameterName& Name of GenICam parameter node to access
Input value inVerifyAccess bool False True to verify GenICam parameter access state before every read
Output value outValue String& Value retrieved from device parameter

Description

This filter is intended for cooperation with a general camera device through a GenTL compliant interface. Its purpose is to get a value of device parameter using GenICam interface. Filter can be used to access device registers and stream chunked data.

Warning: Retrieving parameter from an uncached device register may be a time consuming operation that produce a blocking data exchange at every filter execution.

This filter does not require other GenICam filters in program (especially GenICam_GrabImage is not obligatory), but can be used in any combination with them, including sharing access to single device with other filters.

Device address (inAddress port) is a structure defining a unique device and its GenTL provider module in the system. It is recommended to use the GenTL Device Manager to select the appropriate device, connected to the local system, whose identification information will be used.

Device address consists of the following fields:

  • VendorName - Vendor name of the GenTL provider module, which will be used to communicate with the device.
  • TLType - Identification code of interface transport technology type (for example "GEV", "IIDC", "UVC", "USB3", "PCI", "Custom"). The exact code depends on the GenTL provider module.
  • DeviceID - Unique ID of the device in the selected interface technology of the used provider module. The format of this field must be always an exact ID string and depends on the used GenTL provider module.

This filter will interpret the value of inAddress port only during the first iteration, when the connection to the device is established. During the next iterations the filter will use previously established connection and subsequent changes in the device address will be ignored.

Parameter name (inParameterName port) must be an ID of GenICam parameter exported by the device. Each device model can have different parameter names and its meanings. Refer to the device documentation and use the GenICam settings browser to select appropriate name of parameter .

The name of the parameter must point to a readable GenICam parameter providing "IEnumeration" interface or error will be raised upon program run. Returned value is a textual name of an enumeration entry defined by the device (list of entries is provided in the parameter information box of the GenICam settings browser).

Hints

  • Interactively select a camera available in your network by defining the inAddress input.
  • Choose inParameterName from those supported by your camera.
  • The parameter value read from the camera will be available on the outValue output.

See Also