Configurator.h

Go to the documentation of this file.

#pragma once
 
#include <string>
 
#include <RobotAPI/interface/armem/server/ConfiguringMemoryInterface.h>
 
namespace armarx::armem::client
{
 
    /**
     * @brief Configure a memory server
     *
     * Set the persistence strategy for the ltm of a memory server:
     *  Currently available: REST and DISK
     *  TODO: MongoDB
     */
    class Configurator
    {
 
    public:
        /**
         * @brief Construct a memory reader.
         * @param memory The memory proxy.
         */
        Configurator(const Configurator&) = default;
        Configurator(server::ConfiguringMemoryInterfacePrx configuringMemory = nullptr) :
          configurationPrx(configuringMemory)
        {
 
        }
 
        /**
         * @brief Use a rest server as LTM persistence sink
         * @param identifier LTM identifier that should be unique and is used as <i>origin</i> when any new instances are commited to the wm.
         * @param exportName Export name of the LTM at the rest server (e.g. http:://host:port/exportName/...)
         * @param host ip to the rest server (e.g. localhost or a specific ip)
         * @param port network port on which the server is accessible (e.g. 8080)
         * @param overwritePrevStrategy if true, the newly defined strategy overwrites the current strategy resulting in a single strategy.
         * If false, the newly defined strategy is appened to the current stategies (@see RedundantPersistenceStrategy).
         */
        void useRestPersistenceStrategy(const std::string& identifier, const std::string& exportName, const std::string& host, int port, bool overwritePrevStrategy);
 
        /**
         * @brief Use the disk as LTM persistence sink
         * @param identifier LTM identifier that should be unique and is used as <i>origin</i> when any new instances are commited to the wm.
         * @param exportName Export name of the LTM on the disk (e.g. /exportPath/exportName/...)
         * @param exportPath Base path of the ltm export
         * @param overwritePrevStrategy if true, the newly defined strategy overwrites the current strategy resulting in a single strategy.
         * If false, the newly defined strategy is appened to the current stategies (@see RedundantPersistenceStrategy).
         */
        void useDiskPersistenceStrategy(const std::string& identifier, const std::string& exportName, const std::string& exportPath, bool overwritePrevStrategy);     
 
        void setConfiguringMemory(server::ConfiguringMemoryInterfacePrx configuringMemory);
 
      
        inline
        operator bool() const
        {
            return bool(configurationPrx);
        }
 
    private:
 
    public:
        server::ConfiguringMemoryInterfacePrx configurationPrx;
    };
 
} // namespace armarx::armem::client