File slam_async_tasks.hpp

Interface for launching and monitoring async tasks.

namespace slamcore

Helper conversion methods

slamcore::ImageFormat \(\leftrightarrow\) BytesPerChannel

Get information about the client library

class SLAMAsyncTasksInterface
#include <slam_async_tasks.hpp>

Access to asynchronous tasks.

Subclassed by SLAMSystemInterface

Public Functions

virtual ~SLAMAsyncTasksInterface() = default
virtual IDT launchAsyncTask(TaskType task, const std::map<std::string, std::string> &params) = 0

Launch asynchronous task.

Note

This is asynchronous API, the task might start after this call returns.

Parameters

  • task – Type of task to launch.

  • params – Map of key-value pairs describing task-specific parameters.

Returns

Returned unique identifier to distinguish tasks of the same type.

virtual void cancelAsyncTask(TaskType task, IDT id) = 0

Cancel an existing asynchronous task.

Note

This is asynchronous API, the task might not be cancelled immediately.

Parameters

  • task – Type of task to cancel.

  • id – Unique identifier of the tasks to cancel.

virtual TaskStatusInterface::Ptr getTaskStatus(TaskType task, IDT id) = 0

Get task status.

Parameters

  • task – Type of task to check.

  • id – Unique identifier of the tasks to check.