Back to Aurora Vision Library website

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

AvsFilter_GigEVision_WriteRegisterData


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

Writes binary data into a register node of a GigEVision device.

Syntax

void avs::AvsFilter_GigEVision_WriteRegisterData
(
	GigEVision_WriteRegister_State& ioState,
	const avl::GevAddress& inAddress,
	const avl::GevParameterName& inParameterName,
	bool inVerifyAccess,
	const avl::ByteBuffer& inBuffer
)

Parameters

Name Type Default Description
Input will be modified ioState GigEVision_WriteRegister_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 True True to verify GenICam parameter access state before every write
Input value inBuffer const ByteBuffer& Data to be written to the register

Description

This filter is intended for cooperation with GigE Vision® compliant devices. Its purpose is to set a value into internal device parameter using GenICam interface.

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 device. Each device model can have different parameter names and its meanings. Refer to device documentation and use GenICam settings browser to select appropriate name of parameter (see: Device settings editor section).

This filter allows to write a raw binary data block into the device memory. Source data is provided in form of a ByteBuffer data type on the inBuffer input (filters from the Binary Data category can be used to generate its content). Data is written from the beginning of the register up to the size of the provided buffer. Attempt to write more data than the size of the register range will result in an error. Data will be sent to the device on every filter execution.

The name of the parameter must point to a GenICam parameter providing "IRegister" 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.

Errors

List of possible exceptions:

Error type Description
IoError Writing beyond the end of the register in GigEVision_WriteRegisterData.