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

FisFilter_GigEVision_CheckEvent

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:	fis
Module:	Genicam

Checks if device sent event notification since previous iteration.

Syntax

void fis::FisFilter_GigEVision_CheckEvent
(
	GigEVision_CheckEvent_State& ioState,
	const fil::GevAddress& inAddress,
	int inEventID,
	bool& outEventFired
)

Parameters

Name	Type	Range	Description
ioState	GigEVision_CheckEvent_State&		Object used to maintain state of the function.
inAddress	const GevAddress&		GigE Vision Device identifying address (IP, MAC or Serial Number)
inEventID	int	0 - 65535	Numeric id of event to check
outEventFired	bool&		Gets flag indicating if event was fired since last read

Description

This filter is intended for cooperation with GigE Vision® compliant devices. Its purpose is to monitor device for asynchronous event notifications and report its occurrence in program.

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.

Event ID (inEventID port) is a numeric id of event to listen for. Refer to device documentation for list of events and their ids. Please note, that usually Event ID is specified as hexadecimal number, while standard FIS port value editor use decimal form.

After first execution filter will start monitoring for asynchronous notification of event with specified ID. At every next execution filter will return 'true' on outEventFired port when one or more events with matching ID was received from device since previous filter execution. Port outEventFired is reset to 'false' after every filter execution, preparing filter to listen for next event.

To be able to listen for asynchronous events device must support message channel and event notification, message channel must not be disabled in application parameters, and specified event notification must be explicitly enabled in device settings. Event notification for the specific events can be turned on or off in the device settings under "Event generation" category, accessible through the GigEVision Device Manager.

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.

Errors

List of possible exceptions:

Error type	Description
IoError	Connection with device lost.