HumanProfileWriter.h

Go to the documentation of this file.

#pragma once
 
 
#include <mutex>
#include <optional>
#include <string>
 
#include <ArmarXCore/core/application/properties/PropertyDefinitionContainer.h>
 
#include <RobotAPI/libraries/armem/client/MemoryNameSystem.h>
#include <RobotAPI/libraries/armem/client/Writer.h>
#include <RobotAPI/libraries/armem/client/util/SimpleWriterBase.h>
 
#include <VisionX/libraries/armem_human/aron/PersonInstance.aron.generated.h>
#include <VisionX/libraries/armem_human/client/HumanProfileReader.h>
#include <VisionX/libraries/armem_human/server/HumanMemoryServerInterface.h>
#include <VisionX/libraries/armem_human/types.h>
 
namespace armarx::armem::human::client
{
 
    class ProfileWriter : virtual public armem::client::util::SimpleWriterBase
    {
    public:
        using armem::client::util::SimpleWriterBase::SimpleWriterBase;
 
        ProfileWriter();
 
        ~ProfileWriter() override;
 
        void registerPropertyDefinitions(armarx::PropertyDefinitionsPtr& def);
        void connect(armem::client::MemoryNameSystem& memoryNameSystem);
 
        std::string
        propertyPrefix() const override
        {
            return "mem.human.profile.";
        };
 
        Properties
        defaultProperties() const override
        {
            return Properties{
                .memoryName = "Human", .coreSegmentName = "Profile", .providerName = ""};
        };
 
        // FIXME remove provider, add to c'tor
        bool commitHumanProfile(const Person& humanProfile,
                                const std::string& provider,
                                const armem::Time& referencedTime,
                                const std::string& entityName = "");
 
        bool commitPreferencesToProfile(const armarx::armem::human::PersonID& personID,
                                        const std::string& providerName,
                                        const armem::Time& referencedTime,
                                        const armarx::armem::human::Preferences preferences);
 
        bool setCustomAttributeInProfile(const armarx::armem::human::PersonID& personID,
                                         const std::string& providerName,
                                         const armem::Time& referencedTime,
                                         const std::string key,
                                         const std::string value);
 
        bool commitHumanProfiles(const std::vector<Person>& humanProfiles,
                                 const std::string& provider,
                                 const armem::Time& referencedTime,
                                 const std::string& entityName);
 
        /**
         * Inserts the given drink at the first place of the given humans list of preferred drinks,
         * indicating it is the most favorite drink.
         *
         * If the list already contained the drink before, it is moved to the first entry of the
         * list to prevent duplicate entries.
         *
         * @param personID identifier of the human (first and last name)
         * @param providerName name of the profile provider
         * @param referencedTime the time at which the preference change occured (used for memory
         * timestamp)
         * @param drink human-readable string describing the drink that is preferred (for
         * example, 'orange juice')
         * @return true iff. the preference was updated successfully
         */
        bool setPreferredDrink(const armarx::armem::human::PersonID& personID,
                               const std::string& providerName,
                               const armem::Time& referencedTime,
                               const std::string& drink);
 
    private:
        armem::human::HumanMemoryServerInterfacePrx humanMemory;
        armarx::armem::human::client::ProfileReader reader;
    };
 
} // namespace armarx::armem::human::client