Back to Aurora Vision Library website

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

AvsFilter_GenICam_ExecuteCommand


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

Conditionally executes command in GenICam device.

Syntax

void avs::AvsFilter_GenICam_ExecuteCommand
(
	GenICam_ExecuteCommand_State& ioState,
	const avl::GenAddress& inAddress,
	avl::GenICamParameterScope::Type inScope,
	const avl::GenParameterName& inCommandName,
	avl::GenActivationMode::Type inActivationMode,
	bool inActivation,
	bool inVerifyAccess
)

Parameters

Name Type Default Description
Input will be modified ioState GenICam_ExecuteCommand_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 inCommandName const GenParameterName& Name of GenICam command node to access
Input value inActivationMode GenActivationMode::Type WhenTrue Specifies how filter checks inActivation input
Input value inActivation bool True Activates execution of command
Input value inVerifyAccess bool True True to verify GenICam command parameter access state before every command execution

Description

This filter is intended for cooperation with general camera devices trough GenTL compliant interface. Its purpose is to execute a command in a device using GenICam interface.

This filter does not require other GenICam filters in the program (especially GenICam_GrabImage is not obligatory), but can be used in any combination with them, including shared access to a single device with other filters. The device also does not have to be a transmitter.

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.

A command name (inCommandName port) must be an ID of a GenICam command exported by the device. Each device model can have different command names and their meanings. Refer to the device documentation and use GenICam settings browser to select the appropriate name of a command .

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

Do not execute commands "AcquisitionStart" and "AcquisitionStop" directly in the device with this filter, use GenICam_StartAcquisition and GenICam_StopAcquisition filters instead.

Command execution is controlled by inActivation input. The command in the device is executed at the filter execution point, but only when the value at inActivation input meets its condition. inActivationMode input can be used to specify how the inActivation input is checked. Refer to GenActivationMode enum description for more details.

See Also

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