Application.h

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
 *
 * 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/>.
 *
 * @package    ArmarXCore::core
 * @author     Dennis Weigelt
 * @date       2016
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
 
#pragma once
 
#include <atomic>
#include <filesystem>
#include <memory>
#include <mutex>
#include <string>
 
#include <ArmarXCore/core/application/properties/IceProperties.h>
#include <ArmarXCore/core/application/properties/PropertyDefinitionContainer.h>
 
namespace ScenarioManager::Data_Structure
{
    using PropertyEnabledMap = std::map<std::string, bool>;
 
    /**
    * @class Application
    * @ingroup data_structure
    * @brief Class containing data about an application
    * Provides methods to get and set the date contained in the application. It doesn't manage the application
    * therefore changes in this class won't synchronize to the actual configuration files.
    */
    class Application
    {
 
    private:
        std::string name; /// pretty name of the app
        std::string executableName; /// name of the executable
        std::filesystem::path executablePath; /// directory where the app resides
        std::string packageName;
        /// Refreshed by updateFound(), read from the GUI thread on every status refresh.
        std::atomic<bool> found;
 
    protected:
        /**
        * Guards `properties`, `enabledMap` and `defaultMap`.
        *
        * An application's properties are (re)loaded by the lifecycle worker that starts it while
        * the GUI thread may be displaying them. The lock is deliberately held only around the
        * pointer swap and the map accesses, never around parsing or around generating the property
        * xml - those take seconds and would freeze the GUI. load() therefore builds a complete new
        * container outside the lock and swaps it in, and getProperties() hands out a shared_ptr
        * copy, so a reader keeps a consistent snapshot even if a new one is swapped in meanwhile.
        */
        mutable std::mutex propertiesMutex;
        armarx::PropertyDefinitionsPtr properties;
        PropertyEnabledMap enabledMap;
        PropertyEnabledMap defaultMap;
 
    public:
        /**
        * Constructor that sets the name and the path to the executable of the application.
        * @param name name of the application
        * @param executablePath path to the binary executable of the application
        */
        Application(std::string name, std::string executablePath, std::string packageName);
 
        /**
        * Copy constructor
        * @param name name of the application
        * @param executablePath path to the binary executable of the application
        */
        Application(Application& app);
 
        /**
        * @return the name of this application
        */
        std::string getName();
 
        /**
        * @return the name of executable of this application
        */
        std::string getExecutableName();
 
        /**
        * @return the absolute path to the executable of this application
        */
        std::string getExecutableAbsPath();
 
        /**
        * @return the path to the executable file of this application
        */
        std::string getPathToExecutable();
 
        std::string getPackageName();
 
        bool isDefaultPropertyEnabled(std::string name);
        void setDefaultPropertyEnabled(std::string name, bool enabled);
 
        bool isDefaultProperty(std::string name);
        void setIsDefaultProperty(std::string name, bool defaultValue);
 
        /**
        * @return the properties of this application
        **/
        armarx::PropertyDefinitionsPtr getProperties();
 
        /**
        * Sets the properties of this application. These properties (along with the
        * default config) define the behaviour of the application on start.
        * @param properties new properties
        */
        void setProperties(armarx::PropertyDefinitionsPtr properties);
 
        /**
        * @return whether the executable existed the last time updateFound() ran.
        *
        * Deliberately does not hit the file system: this is read for every application on every
        * status refresh of the GUI, and on a network mounted workspace the stat() calls alone
        * were enough to stall the GUI thread. Call updateFound() to refresh it.
        */
        bool getFound();
 
        /**
        * Checks whether the executable exists and caches the result for getFound().
        * Involves a stat(), so avoid calling it from the GUI thread in a loop.
        */
        void updateFound();
    };
 
    using ApplicationPtr = std::shared_ptr<Application>;
    using ApplicationVectorPtr = std::shared_ptr<std::vector<ApplicationPtr>>;
} // namespace ScenarioManager::Data_Structure