Interface for controlling and monitoring a single real-time task. See RTTaskManager::TaskSubmit and RTTaskManager::TasksGet for getting instances. See Real-Time Tasks for more information. More...

Functions

Action
void	Stop ()
	Stop the task from executing.

void	TimingReset ()
	Reset the timing statistics for the task.

void	Remove ()
	Remove the task from its RTTaskManager.


Status
RTTaskStatus	StatusGet ()
	Get the current status of the task.

int64_t	ExecutionCountAbsoluteWait (int64_t count=ExecutionCountDefault, int32_t timeoutMs=ExecutionCountWaitTimeoutMillisecondsDefault)
	Wait for the task to reach a specific execution count.

int64_t	ExecutionCountRelativeWait (int64_t count=ExecutionCountDefault, int32_t timeoutMs=ExecutionCountWaitTimeoutMillisecondsDefault)
	Wait for the task to execute a specific number of times relative to current count.


Info
int32_t	IdGet ()
	Get the ID of the task.

RTTaskInfo	InfoGet ()
	Get information about the task.

Static Attributes

Constants
static constexpr int64_t	ExecutionCountWaitFailure = -1
	Value returned when waiting for an execution count fails.

static constexpr int64_t	ExecutionCountDefault = 1
	Default number of executions to wait for.

static constexpr int32_t	ExecutionCountWaitTimeoutMillisecondsDefault = 250
	Default timeout for waiting for execution count in milliseconds.

Description

Description:: RTTask provides an interface for controlling and monitoring a single real-time task, including stopping, retrieving status information, and waiting for task execution.

Definition at line 434 of file rttask.h.

Functions