TaskManagerIface Interface

Provides an interface for the task to interact with the task manager/dispatcher. Currently, the only use is to check whether the user has requested a status report, and submit a report if this was the case.

Tasks should poll statusReportRequested() often (e.g. at each iteration), and submit a status report if that function returns true.

bool statusReportRequested()

Return true if a status report was recently requested. If so, you should submit your report using the statusReport() method. This function should be implemented such that it can be called often without performance problems (e.g. check shared variable value).

void submitStatusReport(const TaskStatusReportType &)

Submit the status report if statusReportRequested() returned true. Call this function ONCE only per task, and only if a status report was requested. The behavior of this function otherwise is undefined.

See also the documentation for the Task Interface.