File task_status.hpp

Core API objects - task status.

Helper functions for slamcore::TaskType

template<class Archive>
static inline void load_minimal(const Archive&, TaskType &obj, const std::string &value)
template<class Archive>
static inline std::string save_minimal(const Archive&, const TaskType &obj)
static inline std::ostream &operator<<(std::ostream &os, const TaskType obj)

Helper functions for slamcore::TaskStatusInterface::

template<class Archive>
static inline void load_minimal(const Archive&, TaskStatusInterface::TaskState &obj, const std::string &value)
template<class Archive>
static inline std::string save_minimal(const Archive&, const TaskStatusInterface::TaskState &obj)
static inline std::ostream &operator<<(std::ostream &os, const TaskStatusInterface::TaskState &obj)

Enums

enum class TaskType : EnumBaseT

Tasks to run.

Values:

enumerator SaveSession
enumerator Count
template<typename T>
struct TypeTraits<T, typename enable_if_is_base_of<TaskStatusInterface, T>::type>
#include <task_status.hpp>

Public Static Attributes

static constexpr ObjectType EnumType = ObjectType::TaskStatus
namespace slamcore

Helper conversion methods

slamcore::ImageFormat \(\leftrightarrow\) BytesPerChannel

Helper functions for slamcore::TaskType

template<class Archive>
static inline void load_minimal(const Archive&, TaskType &obj, const std::string &value)
template<class Archive>
static inline std::string save_minimal(const Archive&, const TaskType &obj)
static inline std::ostream &operator<<(std::ostream &os, const TaskType obj)

Helper functions for slamcore::TaskStatusInterface::

template<class Archive>
static inline void load_minimal(const Archive&, TaskStatusInterface::TaskState &obj, const std::string &value)
template<class Archive>
static inline std::string save_minimal(const Archive&, const TaskStatusInterface::TaskState &obj)
static inline std::ostream &operator<<(std::ostream &os, const TaskStatusInterface::TaskState &obj)

Get information about the client library

Enums

enum class TaskType : EnumBaseT

Tasks to run.

Values:

enumerator SaveSession
enumerator Count
class TaskStatusInterface
#include <task_status.hpp>

Task status object.

Public Types

enum class TaskState : EnumBaseT

Values:

enumerator Idle
enumerator Progress
enumerator Success
enumerator Cancelled
enumerator Error
enumerator Count
using Ptr = std::shared_ptr<TaskStatusInterface>
using CPtr = std::shared_ptr<const TaskStatusInterface>

Public Functions

virtual ~TaskStatusInterface() = default
virtual TaskType getType() const = 0

Return the type associated with this task.

virtual IDT getID() const = 0

Return the unique identifier among tasks of the same type.

virtual TaskState getState() const = 0

Return the current state of this task.

virtual std::error_code getError() const = 0

Return task error, if any.

Note

If the task has been cancelled, std::errc::operation_canceled is returned.

template<typename T> type >
#include <task_status.hpp>

Public Static Attributes

static constexpr ObjectType EnumType = ObjectType::TaskStatus