VisionSDK.Events.VisionDeviceEventListener Class Reference

This abstract class defines the methods of an object with the responsibility for checking if some events have occurred on the Vision Device,
or at the VisionDeviceConnection.
This is an abstract class. To make this check, you must subclass this or use VisionDeviceListenerPeriodic. More...

Inheritance diagram for VisionSDK.Events.VisionDeviceEventListener:

Static Public Member Functions
static VisionDeviceEventListener	CreatePeriodic (OperationsExecutionScheduler executionScheduler, IEventsScheduler eventsScheduler, IVisionOperationsFactory factory)
	Static Factory Method More...

Protected Member Functions
	VisionDeviceEventListener (IEventsScheduler eventsScheduler)
	Constructor More...
void	OnConnectionLost ()
	This method will fire the ConnectionLost Event More...
void	OnOccurredEvent (VisionEvent visionEvent)
	This method will fire the Event based on the VisionEvent parameter More...

Protected Attributes
int	numberOfContiguosFailOccurred
	Keep track of the number of failed requests that occurred (cleared each time a successful request is performed) More...
VisionDeviceConnection	deviceConnection
Boolean	checkConnectionStatus
Boolean	listenForOccurredEvents

Properties
Boolean	DiscardDuplicateEvents [get, set]
	If true, this will keep a single type of event for each check and discard the equivalents More...
int	NumberOfContiguosFailBeforeFireConnectionLost [get, set]
	Specify a number of continuous failed checks before firing the Connection Lost event More...
int	NumberOfContiguosFailOccurred [get]
	Return the number of failed requests that occurred More...
VisionDeviceConnection	DeviceConnection [get, set]
	The VisionDeviceConnection on which to check the events More...
Boolean	CheckConnectionStatus [get, set]
	If True, the Connection Status check is performed More...
Boolean	ListenForOccurredEvents [get, set]
	If true, the Events check is performed More...
IEventsScheduler	EventScheduler [get, set]

Events
EventHandler< VisionEventArgs >	DidAcquiredABadImage
	Fired when a Bad Image is acquired from the camera More...
EventHandler< VisionEventArgs >	DidAcquiredAnImage
	Fired when an Image is acquired from the camera More...
EventHandler< VisionEventArgs >	DidLostTheConnection
	Fired if the VisionDeviceConnection loses the connection More...
EventHandler< VisionEventArgs >	DidGoOnline
	Fired when the Vision Device goes to the online state More...
EventHandler< VisionEventArgs >	DidGoOffline
	Fired when the Vision Device goes to the offline state More...
EventHandler< VisionCustomEventArgs >	DidReceivedACustomEvent
	Fired if the Vision Device receives a custom event More...

Detailed Description

This abstract class defines the methods of an object with the responsibility for checking if some events have occurred on the Vision Device,
or at the VisionDeviceConnection.
This is an abstract class. To make this check, you must subclass this or use VisionDeviceListenerPeriodic.

Constructor & Destructor Documentation

VisionSDK.Events.VisionDeviceEventListener.VisionDeviceEventListener ( IEventsScheduler  eventsScheduler )

protected

Constructor

Parameters

eventsScheduler

The connection scheduler that will execute the events on the right dispatcher

Member Function Documentation

static VisionDeviceEventListener VisionSDK.Events.VisionDeviceEventListener.CreatePeriodic ( OperationsExecutionScheduler  executionScheduler, IEventsScheduler  eventsScheduler, IVisionOperationsFactory  factory  )

static

Static Factory Method

Parameters

executionScheduler	The ExecutionScheduler that it will execute the CheckEventOperation
eventsScheduler	The connection scheduler that will execute the events on the right dispatcher
factory	The Factory used to create the CheckEventOperation

void VisionSDK.Events.VisionDeviceEventListener.OnConnectionLost ( )

protected

This method will fire the ConnectionLost Event

void VisionSDK.Events.VisionDeviceEventListener.OnOccurredEvent ( VisionEvent  visionEvent )

protected

This method will fire the Event based on the VisionEvent parameter

Parameters

visionEvent

The VisionEvent to fire

Member Data Documentation

Boolean VisionSDK.Events.VisionDeviceEventListener.checkConnectionStatus

protected

VisionDeviceConnection VisionSDK.Events.VisionDeviceEventListener.deviceConnection

protected

Boolean VisionSDK.Events.VisionDeviceEventListener.listenForOccurredEvents

protected

int VisionSDK.Events.VisionDeviceEventListener.numberOfContiguosFailOccurred

protected

Keep track of the number of failed requests that occurred (cleared each time a successful request is performed)

Property Documentation

Boolean VisionSDK.Events.VisionDeviceEventListener.CheckConnectionStatus

getset

If True, the Connection Status check is performed

VisionDeviceConnection VisionSDK.Events.VisionDeviceEventListener.DeviceConnection

getset

The VisionDeviceConnection on which to check the events

Boolean VisionSDK.Events.VisionDeviceEventListener.DiscardDuplicateEvents

getset

If true, this will keep a single type of event for each check and discard the equivalents

IEventsScheduler VisionSDK.Events.VisionDeviceEventListener.EventScheduler

getsetprotected

Boolean VisionSDK.Events.VisionDeviceEventListener.ListenForOccurredEvents

getset

If true, the Events check is performed

int VisionSDK.Events.VisionDeviceEventListener.NumberOfContiguosFailBeforeFireConnectionLost

getset

Specify a number of continuous failed checks before firing the Connection Lost event

int VisionSDK.Events.VisionDeviceEventListener.NumberOfContiguosFailOccurred

get

Return the number of failed requests that occurred

Event Documentation

EventHandler<VisionEventArgs> VisionSDK.Events.VisionDeviceEventListener.DidAcquiredABadImage

Fired when a Bad Image is acquired from the camera

EventHandler<VisionEventArgs> VisionSDK.Events.VisionDeviceEventListener.DidAcquiredAnImage

Fired when an Image is acquired from the camera

EventHandler<VisionEventArgs> VisionSDK.Events.VisionDeviceEventListener.DidGoOffline

Fired when the Vision Device goes to the offline state

EventHandler<VisionEventArgs> VisionSDK.Events.VisionDeviceEventListener.DidGoOnline

Fired when the Vision Device goes to the online state

EventHandler<VisionEventArgs> VisionSDK.Events.VisionDeviceEventListener.DidLostTheConnection

Fired if the VisionDeviceConnection loses the connection

EventHandler<VisionCustomEventArgs> VisionSDK.Events.VisionDeviceEventListener.DidReceivedACustomEvent

Fired if the Vision Device receives a custom event