CogPrioEvent.Schedule Method (CogPrioEventScheduleTypeConstants, Double)

CogPrioEvent Schedule Method (CogPrioEventScheduleTypeConstants, Double)

Cognex VisionPro 9.8

Manually schedules an I/O event to occur.

Namespace: Cognex.VisionPro.Comm
Assembly: Cognex.VisionPro.Comm (in Cognex.VisionPro.Comm.dll) Version: 75.1.0.0

Syntax

C++

Copy to Clipboard Print

public CogPrioScheduledEventToken Schedule(
	CogPrioEventScheduleTypeConstants scheduleType,
	double scheduleValue
)

public CogPrioScheduledEventToken Schedule(
	CogPrioEventScheduleTypeConstants scheduleType,
	double scheduleValue
)

Public Function Schedule ( 
	scheduleType As CogPrioEventScheduleTypeConstants,
	scheduleValue As Double
) As CogPrioScheduledEventToken

Public Function Schedule ( 
	scheduleType As CogPrioEventScheduleTypeConstants,
	scheduleValue As Double
) As CogPrioScheduledEventToken

public:
CogPrioScheduledEventToken^ Schedule(
	CogPrioEventScheduleTypeConstants scheduleType, 
	double scheduleValue
)

public:
CogPrioScheduledEventToken^ Schedule(
	CogPrioEventScheduleTypeConstants scheduleType, 
	double scheduleValue
)

Parameters

scheduleType: Type: Cognex.VisionPro.Comm CogPrioEventScheduleTypeConstants
Which type of scheduling to use (time or encoder based).

scheduleValue: Type: System Double
How many milliseconds or encoder ticks from now until the scheduled event occurs.

Return Value

Type: CogPrioScheduledEventToken
A CogPrioScheduledEventToken which can be used to discover the instant at which the I/O event was scheduled or to cancel a scheduled event.

Exceptions

Exception	Condition
CogScheduledEventOverflowException	Thrown if event scheduling failed because the maximum number of outstanding scheduled events has been reached (Current firmware sets this limit at 1000).
NotImplementedException	Thrown if scheduleType is set to Encoder.
InvalidOperationException	Thrown if this object is not part of the CogPrio.Events collection or if CogPrio.Valid is false when Schedule() is called.