VisionSDK.Events.VisionDeviceEventListenerPeriodic Class Reference

This class is an Implementation of the VisionDeviceEventListener
This class will poll to perform a check for events and for the connection status with a period defined by the Interval Property. More...

Inheritance diagram for VisionSDK.Events.VisionDeviceEventListenerPeriodic:

Public Member Functions
	VisionDeviceEventListenerPeriodic (OperationsExecutionScheduler executionScheduler, IEventsScheduler eventsScheduler, IVisionOperationsFactory factory)
	Constructor More...
virtual void	CheckEventsAndConnection ()
	This method will force an event check More...

Properties
OperationsExecutionScheduler	ExecutionScheduler [get, set]
	This is the execution scheduler responsable for executing the CheckEventsOperation More...
IVisionOperationsFactory	OperationsFactory [get, set]
	The Factory used to create the CheckEventsOperation More...
Double	Interval [get, set]
	The Polling interval More...
new Boolean	CheckConnectionStatus [get, set]
	If True, performs the Connection Status Check More...
new Boolean	ListenForOccurredEvents [get, set]
	If true, performs the Events Check More...
new VisionDeviceConnection	DeviceConnection [get, set]
	The VisionDeviceConnection on which to check the events More...
Properties inherited from VisionSDK.Events.VisionDeviceEventListener
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]

Additional Inherited Members
Static Public Member Functions inherited from VisionSDK.Events.VisionDeviceEventListener
static VisionDeviceEventListener	CreatePeriodic (OperationsExecutionScheduler executionScheduler, IEventsScheduler eventsScheduler, IVisionOperationsFactory factory)
	Static Factory Method More...
Protected Member Functions inherited from VisionSDK.Events.VisionDeviceEventListener
	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 inherited from VisionSDK.Events.VisionDeviceEventListener
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
Events inherited from VisionSDK.Events.VisionDeviceEventListener
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 class is an Implementation of the VisionDeviceEventListener
This class will poll to perform a check for events and for the connection status with a period defined by the Interval Property.

Constructor & Destructor Documentation

VisionSDK.Events.VisionDeviceEventListenerPeriodic.VisionDeviceEventListenerPeriodic	(	OperationsExecutionScheduler	executionScheduler,
		IEventsScheduler	eventsScheduler,
		IVisionOperationsFactory	factory
	)

Constructor

Parameters

executionScheduler	The ExecutionScheduler that 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

Member Function Documentation

virtual void VisionSDK.Events.VisionDeviceEventListenerPeriodic.CheckEventsAndConnection ( )

virtual

This method will force an event check

Property Documentation

new Boolean VisionSDK.Events.VisionDeviceEventListenerPeriodic.CheckConnectionStatus

getset

If True, performs the Connection Status Check

new VisionDeviceConnection VisionSDK.Events.VisionDeviceEventListenerPeriodic.DeviceConnection

getset

The VisionDeviceConnection on which to check the events

OperationsExecutionScheduler VisionSDK.Events.VisionDeviceEventListenerPeriodic.ExecutionScheduler

getset

This is the execution scheduler responsable for executing the CheckEventsOperation

Double VisionSDK.Events.VisionDeviceEventListenerPeriodic.Interval

getset

The Polling interval

new Boolean VisionSDK.Events.VisionDeviceEventListenerPeriodic.ListenForOccurredEvents

getset

If true, performs the Events Check

IVisionOperationsFactory VisionSDK.Events.VisionDeviceEventListenerPeriodic.OperationsFactory

getset

The Factory used to create the CheckEventsOperation