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

GenICam_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 GenICam device.

Syntax

void avs::GenICam_WriteRegisterData
(
	GenICam_WriteRegister_State& ioState,
	const avl::GenAddress& inAddress,
	avl::GenICamParameterScope::Type inScope,
	const avl::GenParameterName& inParameterName,
	bool inVerifyAccess,
	const avl::ByteBuffer& inBuffer
)

Parameters

Name	Type	Default	Description
ioState	GenICam_WriteRegister_State&		Object used to maintain state of the function.
inAddress	const GenAddress&		GenTL Provider module and device identifying address
inScope	GenICamParameterScope::Type		Specifies which parameters set in GenICam stack should be accessed
inParameterName	const GenParameterName&		Name of GenICam parameter node to access
inVerifyAccess	bool	True	True to verify GenICam parameter access state before every write
inBuffer	const ByteBuffer&		Data to be written to the register

Description

This filter is intended for cooperation with general camera device trough GenTL compliant interface. Its purpose is to set a value into internal device parameter using GenICam interface.

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

This filter allows to write a raw binary data block into the device or module 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/module 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.

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: