Back to Aurora Vision Library website

You are here: Start » Function Reference » GigE Vision » AvsFilter_GigEVision_GetLongParameter

AvsFilter_GigEVision_GetLongParameter


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 Long from GigEVision device.

Syntax

void avs::AvsFilter_GigEVision_GetLongParameter
(
	GigEVision_GetIntegerParameter_State& ioState,
	const avl::GevAddress& inAddress,
	const avl::GevParameterName& inParameterName,
	bool inVerifyAccess,
	atl::int64& outValue
)

Parameters

Name Type Default Description
Input will be modified ioState GigEVision_GetIntegerParameter_State& Object used to maintain state of the function.
Input value inAddress const GevAddress& GigE Vision Device identifying address (IP, MAC or Serial Number)
Input value inParameterName const GevParameterName& 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 int64& Value retrieved from device parameter

Description

This filter is intended for cooperation with GigE Vision® compliant devices. Its purpose is to get a value of device parameter using GenICam interface. Filter can be used to access device registers, stream chunked data or event message data.

Warning: Retrieving parameters from uncached device registers may be a time consuming operation that produce blocking network packets exchange at every filter execution.

This filter does not require other GigE Vision® filters in program (especially GigEVision_GrabImage is not obligatory), but can be used in any combination with them, including sharing access to single device with other filters. Device also does not have to be a transmitter.

Device address (inAddress port) is a textual definition of either IP, MAC or serial number. Use Device Manager to select appropriate address of connected device.

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 the parameter (see: Device settings editor section).

The name of the parameter must point to a readable GenICam parameter providing "IInteger" interface or error will be raised upon filter execution.

For general information about working with GigE Vision devices, please refer to the following article.

To learn more about camera acquisition thread works please go to this article.

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.