CogPrioImpl.ScheduleIOEvent Method

CogPrioImpl ScheduleIOEvent Method

Cognex VisionPro 9.22 SR1

Manually schedules an I/O event to occur.

Namespace: Cognex.VisionPro.Comm.Implementation.Internal
Assembly: Cognex.VisionPro.Comm (in Cognex.VisionPro.Comm.dll) Version: 87.1.0.0

Syntax

C++

Copy to Clipboard Print

public virtual void ScheduleIOEvent(
	int eventNumber,
	CogPrioImplEventScheduleTypeConstants scheduleType,
	long scheduleValue,
	int scheduledUserDataTag,
	out int scheduledEventInstanceTag,
	out CogPrioState state
)

public virtual void ScheduleIOEvent(
	int eventNumber,
	CogPrioImplEventScheduleTypeConstants scheduleType,
	long scheduleValue,
	int scheduledUserDataTag,
	out int scheduledEventInstanceTag,
	out CogPrioState state
)

Public Overridable Sub ScheduleIOEvent ( 
	eventNumber As Integer,
	scheduleType As CogPrioImplEventScheduleTypeConstants,
	scheduleValue As Long,
	scheduledUserDataTag As Integer,
	<OutAttribute> ByRef scheduledEventInstanceTag As Integer,
	<OutAttribute> ByRef state As CogPrioState
)

Public Overridable Sub ScheduleIOEvent ( 
	eventNumber As Integer,
	scheduleType As CogPrioImplEventScheduleTypeConstants,
	scheduleValue As Long,
	scheduledUserDataTag As Integer,
	<OutAttribute> ByRef scheduledEventInstanceTag As Integer,
	<OutAttribute> ByRef state As CogPrioState
)

public:
virtual void ScheduleIOEvent(
	int eventNumber, 
	CogPrioImplEventScheduleTypeConstants scheduleType, 
	long long scheduleValue, 
	int scheduledUserDataTag, 
	[OutAttribute] int% scheduledEventInstanceTag, 
	[OutAttribute] CogPrioState^% state
)

public:
virtual void ScheduleIOEvent(
	int eventNumber, 
	CogPrioImplEventScheduleTypeConstants scheduleType, 
	long long scheduleValue, 
	int scheduledUserDataTag, 
	[OutAttribute] int% scheduledEventInstanceTag, 
	[OutAttribute] CogPrioState^% state
)

Parameters

eventNumber: Type: System Int32
The registered IO Event ID to schedule.

scheduleType: Type: Cognex.VisionPro.Comm.Implementation.Internal CogPrioImplEventScheduleTypeConstants
An enum which controls which type of scheduling to use (i.e. encoder based, or time based scheduling).

scheduleValue: Type: System Int64
A value which controls when the event is scheduled to occur (i.e. number of encoder ticks, or a particular time stamp) depending on the scheduleType.

scheduledUserDataTag: Type: System Int32
A return value which can be used to identify a particular scheduled event instance from the HostNotification event.

scheduledEventInstanceTag: Type: System Int32
A return value which can be used to identify and cancel the instance of the scheduled event.

state: Type: Cognex.VisionPro.Comm CogPrioState
Returns the state of the comm card immediately after the event was scheduled. The I/O state includes the timestamp and encoder count. These values can be useful when trying to determine if the event was scheduled "in time".