TaskOutcomeReader.h

Go to the documentation of this file.

#pragma once
 
#include <RobotAPI/libraries/armem/client/query/Builder.h>
#include <RobotAPI/libraries/armem/client/util/SimpleReaderBase.h>
#include <RobotAPI/libraries/armem/core/Time.h>
 
#include <RobotAPI/libraries/armem_task_outcome/types.h>
 
namespace armarx::armem::task_outcome::client
{
 
    class TaskOutcomeReader : virtual public armarx::armem::client::util::SimpleReaderBase
    {
    public:
        using armarx::armem::client::util::SimpleReaderBase::SimpleReaderBase;
        ~TaskOutcomeReader() override;
 
        struct Query
        {
            std::string providerName;
            std::optional<TaskType> taskTypeFilter;
            std::optional<TaskOutcomeType> outcomeFilter;
            armem::Time timestamp;
            Duration maxAge;
        };
 
        struct Result
        {
            std::vector<TaskOutcome> outcomes{};
 
            enum class Status
            {
                Success,
                NoData,
                Error
            } status;
 
            std::string errorMessage = "";
 
            operator bool() const noexcept
            {
                return status != Status::Error;
            }
        };
 
        Result query(const Query& query) const;
 
        std::vector<TaskOutcome> queryByTaskType(TaskType taskType,
                                                  const Duration& maxAge) const;
 
        std::vector<TaskOutcome> queryFailures(const Duration& maxAge) const;
 
    protected:
        ::armarx::armem::client::query::Builder buildQuery(const Query& query) const;
 
        std::vector<TaskOutcome>
        asTaskOutcomes(const wm::ProviderSegment& providerSegment,
                       const DateTime& timestamp,
                       const Duration& maxAge,
                       const std::optional<TaskType>& taskTypeFilter,
                       const std::optional<TaskOutcomeType>& outcomeFilter) const;
 
        std::string propertyPrefix() const override;
        Properties defaultProperties() const override;
    };
 
} // namespace armarx::armem::task_outcome::client