Task Event Datatypes

OcaExecutableType

enum OcaExecutableType : uint8_t

Types of executable - program or commandset

enumerator Undefined = 0: Executable type is undefined.

enumerator Program = 1: Executable is a Program.

enumerator Commandset = 2: Executable is a Commandset.

OcaJobDisposition

enum OcaJobDisposition : uint8_t

Types of run queue item disposition

enumerator RunStarted = 1: Task Scheduler has successfully started the Executable.

enumerator ItemDeleted = 2: Controller explicitly deleted he queue item using the DeleteRunQueueItem() or ClearRunQueue() method.

enumerator FailedToStart_TaskNotAvailable = 3: Executable could not start because designated Task was busy or no free Task was available.

enumerator FailedToStart_TaskNotCompatible = 4: Executable could not start because designated Task was incompatible with the given Program or Commandset, or the requested RunMode was not supported.

enumerator FailedToStart_ResourceUnavailable = 5: Executable could not start because a required Device resource was unavailable.

enumerator FailedToStart_DeviceError = 6: Executable could not start because of a Device error.

OcaJobDisposedEventData

struct OcaJobDisposedEventData

Notification data emitted by the OcaTaskScheduler.RunQueueItemDisposed event.

OcaJobQueueItem QueueItem: The job queue item that is the subject of this event

OcaJobDisposition Disposition: Enum specifying what happened to the queue item.

OcaBlob DispositionDetails: Optional disposition details

OcaTaskExecutionTerminatedEventData

struct OcaTaskExecutionTerminatedEventData

Notification data emitted by the OcaTaskAgent.TaskChanged event upon successful or unsuccessful termination of an Executable the task agent has been running.

OcaExecutableType ExecutableType: Type of Executable - Program or Commandset.

OcaONo ExecutableONo: Object number of Executable.

OcaVariant<OcaProgramResult, OcaCommandSetResult> Result: Execution result: {generic status, program-type-specific details}. Datatype depends on whether Executable is a Program or a Commandset.