Writer.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     Fabian Reister ( fabian dot reister at kit dot edu )
 * @date       2026
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
#include <mutex>
#include <string>
#include <vector>
 
#include <RobotAPI/libraries/armem/client/util/SimpleWriterBase.h>
#include <RobotAPI/libraries/armem/core/forward_declarations.h>
 
#include <armarx/navigation/algorithms/Room.h>
 
namespace armarx::navigation::memory::client::rooms
{
 
    /**
     * @brief Writes rooms into the `Rooms` core segment of the navigation memory.
     *
     * The entity name of a room is its `Room::name`, matching the layout produced by
     * the navigation memory when loading a `rooms.json` file.
     */
    class Writer : virtual public armarx::armem::client::util::SimpleWriterBase
    {
    public:
        using armarx::armem::client::util::SimpleWriterBase::SimpleWriterBase;
        ~Writer() override;
 
        bool store(const armarx::navigation::algorithms::Room& room,
                   const std::string& providerName,
                   const armem::Time& timestamp);
 
        bool store(const std::vector<armarx::navigation::algorithms::Room>& rooms,
                   const std::string& providerName,
                   const armem::Time& timestamp);
 
    protected:
        std::string propertyPrefix() const override;
        Properties defaultProperties() const override;
 
    private:
        std::mutex writeMutex;
    };
 
} // namespace armarx::navigation::memory::client::rooms