Commit.h

Go to the documentation of this file.

#pragma once
 
#include <RobotAPI/libraries/armem/core/Time.h>
#include <RobotAPI/libraries/armem/core/MemoryID.h>
 
#include <RobotAPI/libraries/aron/core/data/variant/forward_declarations.h>
 
#include <memory>
#include <vector>
 
 
namespace armarx::armem
{
 
    enum class UpdateType
    {
        UpdatedExisting,
        InsertedNew
    };
 
    struct EntityUpdate
    {
        MemoryID entityID;
 
        std::vector<aron::data::DictPtr> instancesData;
 
        Time timeCreated = Time::Invalid();
 
 
        // OPTIONAL
 
        float confidence = 1.0;
 
 
        // OPTIONAL
 
        Time timeSent = Time::Invalid();
 
        Time timeArrived = Time::Invalid();
 
 
        friend std::ostream& operator<<(std::ostream& os, const EntityUpdate& rhs);
    };
 
 
    struct EntityUpdateResult
    {
        bool success = false;
 
        MemoryID snapshotID;
        Time timeArrived = Time::Invalid();
 
        std::string errorMessage;
 
        friend std::ostream& operator<<(std::ostream& os, const EntityUpdateResult& rhs);
    };
 
 
 
    struct Commit
    {
        std::vector<EntityUpdate> updates;
 
        EntityUpdate& add();
        EntityUpdate& add(const EntityUpdate& update);
        void add(const std::vector<EntityUpdate>& updates);
        void append(const Commit& c);
 
        friend std::ostream& operator<<(std::ostream& os, const Commit& rhs);
    };
 
    struct CommitResult
    {
        std::vector<EntityUpdateResult> results;
 
        bool allSuccess() const;
        std::vector<std::string> allErrorMessages() const;
 
        friend std::ostream& operator<<(std::ostream& os, const CommitResult& rhs);
    };
 
 
}