HumanProfileReader.h

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * ArmarX is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * ArmarX is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * @author     Joana Plewnia 
 * @date       2025
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
#include <RobotAPI/libraries/armem/client/query/Builder.h>
#include <RobotAPI/libraries/armem/client/util/SimpleReaderBase.h>
 
#include <VisionX/libraries/armem_human/types.h>
 
namespace armarx::armem::human::client
{
 
    class ProfileReader : virtual public armarx::armem::client::util::SimpleReaderBase
    {
    public:
        using armarx::armem::client::util::SimpleReaderBase::SimpleReaderBase;
        ~ProfileReader() override;
 
        struct Query
        {
            // if empty, will query all providers
            std::string providerName;
            armem::Time timestamp;
 
            Duration maxAge;
        };
 
        struct Result
        {
            std::vector<armarx::armem::human::Person> humanProfiles{};
 
            enum class Status
            {
                Success,
                NoData,
                Error
            } status;
 
            std::string errorMessage = "";
 
            operator bool() const noexcept
            {
                return status != Status::Error;
            }
        };
 
        Result query(const Query& query, bool latest) const;
 
        armarx::armem::human::Preferences
        queryPreferences(const std::string& firstName,
                         const std::string& lastName,
                         const Duration& maxAge,
                         const std::string& providerName = "All Profiles");
 
        armarx::armem::human::Person
        queryLatestProfileByName(const std::string& firstName,
                                 const std::string& lastName,
                                 const std::string& providerName = "All Profiles");
 
        /**
         * Returns a list of a humans preferred drinks.
         *
         * @param firstName first name of the human
         * @param lastName last name of the human
         * @param providerName name of the profile provider
         * @return a list of strings where each string describes a drink (e.g. 'orange juice').
         * By convention, the first entry in the list can be used as the most favorite drink.
         */
        std::vector<std::string>
        getPreferredDrinks(const std::string& firstName,
                           const std::string& lastName,
                           const std::string& providerName = "All Profiles");
 
 
    protected:
        ::armarx::armem::client::query::Builder buildQuery(const Query& query) const;
 
        ::armarx::armem::client::query::Builder buildLatestQuery(const Query& query) const;
 
        std::vector<armarx::armem::human::Person>
        asPersonProfiles(const wm::ProviderSegment& providerSegment,
                         const DateTime& timestamp,
                         const Duration& maxAge) const;
 
        std::string propertyPrefix() const override;
        Properties defaultProperties() const override;
    };
 
} // namespace armarx::armem::human::client