HumanProfileReader.cpp

Go to the documentation of this file.

#include "HumanProfileReader.h"
 
#include <iterator>
 
#include "ArmarXCore/core/exceptions/local/ExpressionException.h"
#include "ArmarXCore/core/logging/Logging.h"
 
#include <RobotAPI/libraries/armem/util/util.h>
 
#include <VisionX/libraries/armem_human/aron/PersonInstance.aron.generated.h>
#include <VisionX/libraries/armem_human/aron_conversions.h>
 
namespace armarx::armem::human::client
{
    ProfileReader::~ProfileReader() = default;
 
    armarx::armem::client::query::Builder
    ProfileReader::buildQuery(const Query& query) const
    {
        armarx::armem::client::query::Builder qb;
 
        armarx::armem::client::query::CoreSegmentSelector& coreSegmentQuery =
            qb.coreSegments().withName(properties().coreSegmentName);
 
        armarx::armem::client::query::ProviderSegmentSelector& providerQuery =
            [&]() -> armem::client::query::ProviderSegmentSelector&
        {
            if (not query.providerName.empty())
            {
                return coreSegmentQuery.providerSegments().withName(query.providerName);
            }
            return coreSegmentQuery.providerSegments().all();
        }();
 
        providerQuery.entities().all().snapshots().beforeOrAtTime(query.timestamp);
 
        return qb;
    }
 
    ::armarx::armem::client::query::Builder
    ProfileReader::buildLatestQuery(const Query& query) const
    {
        armarx::armem::client::query::Builder qb;
 
        armarx::armem::client::query::CoreSegmentSelector& coreSegmentQuery =
            qb.coreSegments().withName(properties().coreSegmentName);
 
        armarx::armem::client::query::ProviderSegmentSelector& providerQuery =
            [&]() -> armem::client::query::ProviderSegmentSelector&
        {
            if (not query.providerName.empty())
            {
                return coreSegmentQuery.providerSegments().withName(query.providerName);
            }
            return coreSegmentQuery.providerSegments().all();
        }();
 
        providerQuery.entities().all().snapshots().latest();
 
        return qb;
    }
 
    std::vector<armarx::armem::human::Person>
    ProfileReader::asPersonProfiles(const wm::ProviderSegment& providerSegment,
                                    const DateTime& timestamp,
                                    const Duration& maxAge) const
    {
        ARMARX_TRACE;
        std::vector<Person> humanProfiles;
 
        providerSegment.forEachEntity(
            [&](const wm::Entity& entity)
            {
                ARMARX_TRACE;
 
                const auto& entitySnapshot = entity.getLatestSnapshot();
 
                entitySnapshot.forEachInstance(
                    [&humanProfiles, &timestamp, &maxAge](const auto& entityInstance)
                    {
                        ARMARX_TRACE;
 
                        const core::time::Duration dtToNow =
                            timestamp - entityInstance.metadata().referencedTime;
 
                        if (dtToNow < maxAge and dtToNow.isPositive())
                        {
                            const auto aronDto =
                                tryCast<armarx::human::arondto::Person>(entityInstance);
                            ARMARX_CHECK(aronDto) << "Failed casting to Profile";
 
                            Person humanProfile;
                            fromAron(*aronDto, humanProfile);
 
                            humanProfiles.push_back(humanProfile);
                        };
                    });
            });
 
        return humanProfiles;
    }
 
    std::string
    ProfileReader::propertyPrefix() const
    {
        return "mem.human.profile.";
    }
 
    armarx::armem::client::util::SimpleReaderBase::Properties
    ProfileReader::defaultProperties() const
    {
        return {.memoryName = "Human", .coreSegmentName = "Profile"};
    }
 
    ProfileReader::Result
    ProfileReader::query(const Query& query, bool latest) const
    {
        ARMARX_TRACE;
 
        ::armarx::armem::client::query::Builder qb;
        if (latest)
        {
            qb = buildLatestQuery(query);
        }
        else
        {
            qb = buildQuery(query);
        }
 
        ARMARX_DEBUG << "[MappingDataReader] query ... ";
 
        const armem::client::QueryResult qResult = memoryReader().query(qb.buildQueryInput());
 
        ARMARX_DEBUG << "[MappingDataReader] result: " << qResult;
 
        if (not qResult.success)
        {
            ARMARX_WARNING << "Failed to query data from memory: " << qResult.errorMessage;
            return {.humanProfiles = {},
                    .status = Result::Status::Error,
                    .errorMessage = qResult.errorMessage};
        }
 
        ARMARX_TRACE;
        const auto coreSegment = qResult.memory.getCoreSegment(properties().coreSegmentName);
 
        if (query.providerName.empty())
        {
            ARMARX_TRACE;
 
            std::vector<Person> allHumanProfiles;
 
            coreSegment.forEachProviderSegment(
                [this, &allHumanProfiles, &query](const auto& providerSegment)
                {
                    const std::vector<Person> humanProfiles =
                        asPersonProfiles(providerSegment, query.timestamp, query.maxAge);
                    std::copy(humanProfiles.begin(),
                              humanProfiles.end(),
                              std::back_inserter(allHumanProfiles));
                });
 
            if (allHumanProfiles.empty())
            {
                // ARMARX_WARNING << "No entities.";
                return {.humanProfiles = {},
                        .status = Result::Status::NoData,
                        .errorMessage = "No entities"};
            }
 
            return Result{.humanProfiles = allHumanProfiles, .status = Result::Status::Success};
        }
 
        ARMARX_TRACE;
 
        // -> provider segment name is set
        if (not coreSegment.hasProviderSegment(query.providerName))
        {
            ARMARX_INFO << deactivateSpam(5) << "Provider segment `" << query.providerName
                        << "` does not exist (yet).";
            return {.humanProfiles = {}, .status = Result::Status::NoData};
        }
 
        ARMARX_TRACE;
 
        const wm::ProviderSegment& providerSegment =
            coreSegment.getProviderSegment(query.providerName);
 
        if (providerSegment.empty())
        {
            ARMARX_WARNING << "No entities.";
            return {.humanProfiles = {},
                    .status = Result::Status::NoData,
                    .errorMessage = "No entities"};
        }
 
        try
        {
            ARMARX_TRACE;
 
            const auto humanProfiles =
                asPersonProfiles(providerSegment, query.timestamp, query.maxAge);
            return Result{.humanProfiles = humanProfiles, .status = Result::Status::Success};
        }
        catch (...)
        {
            return Result{.status = Result::Status::Error,
                          .errorMessage = GetHandledExceptionString()};
        }
    }
 
    Preferences
    ProfileReader::queryPreferences(const std::string& firstName,
                                    const std::string& lastName,
                                    const Duration& maxAge,
                                    const std::string& providerName)
    {
        Query queryDefinition = Query{//for now we query all provider segments
                                      //for now we do not provide a timestamp
                                      .providerName = providerName,
                                      .timestamp = armem::Time::Now(),
                                      .maxAge = maxAge};
 
        auto queryResult = query(queryDefinition, true);
 
        std::vector<Preference> preferences;
 
        if (queryResult.status == Result::Status::Success)
        {
            for (const auto& profile : queryResult.humanProfiles)
            {
                if (profile.id.firstName == firstName && profile.id.lastName == lastName)
                {
                    //we for now believe first and last name in combination uniquely define one person
                    return profile.preferences;
                }
            }
 
            ARMARX_WARNING
                << "You tried to query a (Human) Profile, but the query was not successful "
                << "because the person does not exist. Check first and last name.";
        }
        else
        {
            ARMARX_WARNING
                << "You tried to query a (Human) Profile, but the query was not successful";
        }
 
        return {};
    }
 
    Person
    ProfileReader::queryLatestProfileByName(const std::string& firstName,
                                            const std::string& lastName,
                                            const std::string& providerName)
    {
        Query queryDefinition = Query{//for now we query all provider segments
                                      //for now we do not provide a timestamp
                                      .providerName = providerName,
                                      .timestamp = armem::Time::Now(),
                                      .maxAge = armarx::Duration::Minutes(1000)};
 
        auto queryResult = query(queryDefinition, true);
 
        Person preferences;
 
        if (queryResult.status == Result::Status::Success)
        {
            for (const auto& profile : queryResult.humanProfiles)
            {
                if (profile.id.firstName == firstName && profile.id.lastName == lastName)
                {
                    //we for now believe first and last name in combination uniquely define one person
                    return profile;
                }
            }
 
            ARMARX_WARNING
                << "You tried to query a (Human) Profile, but the query was not successful "
                << "because the person does not exist. Check first and last name.";
        }
        else
        {
            ARMARX_WARNING
                << "You tried to query a (Human) Profile, but the query was not successful";
        }
 
        ARMARX_WARNING << "empty profile being returned";
        return {};
    }
 
    std::vector<std::string>
    ProfileReader::getPreferredDrinks(const std::string& firstName,
                                      const std::string& lastName,
                                      const std::string& providerName)
    {
        Preferences preferences =
            queryPreferences(firstName, lastName, armarx::Duration::Hours(1000), providerName);
        if (!preferences.drink.has_value())
        {
            return {};
        }
        return preferences.drink->preferred;
    }
 
} // namespace armarx::armem::human::client