Back to Aurora Vision Library website

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

GenICam_SetBoolParameter


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

Sets parameter of type Bool into GenICam device.

Syntax

void avs::GenICam_SetBoolParameter
(
	GenICam_SetBoolParameter_State& ioState,
	const avl::GenAddress& inAddress,
	avl::GenICamParameterScope::Type inScope,
	const avl::GenParameterName& inParameterName,
	bool inValue,
	bool inVerify
)

Parameters

Name Type Default Description
Input will be modified ioState GenICam_SetBoolParameter_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 inValue bool New value to be set into device parameter
Input value inVerify bool True True to verify GenICam parameter access state and value correctness before every write

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 .

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

Value from the inValue port will be sent to the device only upon its change.

Hints

  • Interactively select a camera available in your network by defining the inAddress input.
  • Choose inParameterName from those supported by your camera.
  • Set or connect inValue to specify a new value for the selected camera parameter.

See Also

  • GenICam_GrabImage – Captures an image stream from a camera using a GenICam GenTL provider library.