WKernel.h

//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
 
#ifndef WKERNEL_H
#define WKERNEL_H
 
#include <memory>
#include <string>
#include <vector>
 
 
#include "../common/WTimer.h"
#include "WSelectionManager.h"
#include "../graphicsEngine/WGraphicsEngine.h"
#include "../scripting/WScriptEngine.h"
#include "WBatchLoader.h"
 
// forward declarations
class WUI;
class WModule;
class WModuleContainer;
class WModuleFactory;
class WROIManager;
class WThreadedRunner;
 
/**
 * \defgroup kernel Kernel
 *
 * \brief
 * This library implements the central part of OpenWalnut that manages
 * the interaction between UI, GraphicsEngine and DataHandler.
 */
 
/**
 * OpenWalnut kernel, managing modules and interaction between
 * UI, GE and DataHandler
 * \ingroup kernel
 */
class WKernel: public WThreadedRunner
{
public:
    /**
     * Signal for generic events.
     *
     */
    typedef boost::function< void ( void ) > t_KernelGenericSignalHandlerType;
 
    /**
     * Generic signal type used in the most signals.
     */
    typedef boost::signals2::signal< void ( void ) >  t_KernelGenericSignalType;
 
    /**
     * Enum of all possible signals WKernel instances can emit.
     */
    typedef enum
    {
        KERNEL_STARTUPCOMPLETE  // when kernel, GE and UI are correctly initialized
    }
    KERNEL_SIGNAL;
 
    /**
     * Returns pointer to the running kernel or a new if no kernel was there.
     * If a running kernel exists the function return it and does not check if
     * GE and UI of the running kernel are equivalent to the ones given as parameters.
     *
     * \param ge initialized graphics engine.
     * \param ui initialized ui.
     * \return the kernel instance.
     */
    static WKernel* instance( std::shared_ptr< WGraphicsEngine > ge, std::shared_ptr< WUI > ui );
 
    /**
     * Destructor.
     */
    virtual ~WKernel();
 
    // Tell the compiler that we really want to use the base's subscribeSignal.
    using WThreadedRunner::subscribeSignal;
 
    /**
     * Subscribe to several signals.
     *
     * \param signal the signal to subscribe
     * \param notifier the notifier to call
     *
     * \return connection variable. Keep this in any case. If not, the connection may be lost.
     */
    boost::signals2::connection subscribeSignal( KERNEL_SIGNAL signal, t_KernelGenericSignalHandlerType notifier );
 
    /**
     * Stops execution of the modules in the root container. Note that this does not wait for the kernel thread since this could
     * cause a dead lock. This is actually an alias for getRootContainer()->stop().
     */
    void finalize();
 
    /**
     * Returns pointer to currently running instance of graphics engine.
     *
     * \return the graphics engine instance.
     */
    std::shared_ptr< WGraphicsEngine > getGraphicsEngine() const;
 
    /**
     * Returns pointer to the currently running kernel.
     *
     * \return the kernel instance.
     */
    static WKernel* getRunningKernel();
 
    /**
     * Determines whether all threads should finish.
     *
     * \return true if so.
     */
    const WBoolFlag& isFinishRequested() const;
 
    /**
     * Load specified datasets. It immediately returns and starts another thread, which actually loads the data.
     *
     * \param filenames list of filenames to load. The registered notification handler for the root container will get notified on
     * error and success.
     * \param suppressColormaps if true, the data modules are instructed to avoid registration of colormaps. This can be very handy if you
     * combine multiple data loaders into one new data loader or data set
     *
     * \return the batch loader responsible for loading. Can be queried for the list of data modules.
     */
    WBatchLoader::SPtr loadDataSets( std::vector< std::string > filenames, bool suppressColormaps = false );
 
    /**
     * Loads the specified files synchronously.
     *
     * \param filenames list of filenames to load. The registered notification handler for the root container will get notified on
     * error and success.
     * \param suppressColormaps if true, the data modules are instructed to avoid registration of colormaps. This can be very handy if you
     * combine multiple data loaders into one new data loader or data set
     *
     * \return the batch loader responsible for loading. Can be queried for the list of data modules.
     */
    WBatchLoader::SPtr loadDataSetsSynchronously( std::vector< std::string > filenames, bool suppressColormaps = false );
 
    /**
     * Function combines to modules. This is a simple alias for "getRootContainer()->applyModule". It runs synchronously, which
     * could freeze the calling thread for a couple of time.
     *
     * \param applyOn the module which already has to be in the container and to apply the other one on.
     * \param prototype the prototype of the module to apply on the other one specified.
     *
     * \return the newly created module connected with the one specified in applyOn.
     */
    std::shared_ptr< WModule > applyModule( std::shared_ptr< WModule > applyOn, std::shared_ptr< WModule > prototype );
 
    /**
     * Returns the root module container. This is the actual module graph container.
     *
     * \return the root container.
     */
    std::shared_ptr< WModuleContainer > getRootContainer() const;
 
    /**
     * Getter for the associated UI.
     *
     * \return the UI.
     */
    std::shared_ptr< WUI > getUI() const;
 
    /**
     * get for roi manager
     *
     * \return Pointer to the ROI manager.
     */
    std::shared_ptr< WROIManager> getRoiManager();
 
    /**
     * get for selection manager
     *
     * \return Pointer to the selection manager.
     */
    std::shared_ptr< WSelectionManager> getSelectionManager();
 
    /**
     * Get the script engine of this kernel.
     *
     * \return A pointer to the script engine.
     */
    std::shared_ptr< WScriptEngine > getScriptEngine();
 
    /**
     * Returns the system timer. If you need timing for animations and similar, use this one. This timer can change to frame based timing if the
     * user plays back some animation. So, everything which uses this timer can always do accurate per-frame animations even if frame time and
     * real-time differ.
     *
     * \return the timer
     */
    WTimer::ConstSPtr getTimer() const;
 
protected:
    /**
     * Constructor is protected because this class is a singleton. Awaits an INITIALIZED graphics engine an UI.
     *
     * \param ge initialized graphics engine.
     * \param ui initialized UI.
     */
    WKernel( std::shared_ptr< WGraphicsEngine > ge, std::shared_ptr< WUI > ui );
 
    /**
     * Function that has to be overwritten for execution. It gets executed in a separate thread after run()
     * has been called.
     */
    virtual void threadMain();
 
    /**
     * The UI.
     */
    std::shared_ptr< WUI > m_ui;
 
    /**
     * Pointer to an initialized graphics engine.
     */
    std::shared_ptr< WGraphicsEngine > m_graphicsEngine;
 
    /**
     * Pointer to a roi manager
     */
    std::shared_ptr< WROIManager >m_roiManager;
 
    /**
     * pointer to a selection manager
     */
    std::shared_ptr< WSelectionManager >m_selectionManager;
 
    /**
     * The module factory to use.
     */
    std::shared_ptr< WModuleFactory > m_moduleFactory;
 
    /**
     * The container containing the modules.
     */
    std::shared_ptr< WModuleContainer > m_moduleContainer;
 
    /**
     * The script engine to use.
     */
    std::shared_ptr< WScriptEngine > m_scriptEngine;
 
private:
    /**
     * Loads all the modules it can find.
     */
    void loadModules();
 
    /**
     * Initializes the graphics engine, data handler and so on.
     */
    void init();
 
    /**
     * Pointer to the unique instance of this singleton class.
     */
    static WKernel* m_kernel;
 
    /**
     * The ow system timer.
     */
    WTimer::SPtr m_timer;
 
    /**
     * Notified when the startup, including GE and UI has been completed.
     */
    WConditionOneShot m_startupCompleted;
};
 
#endif  // WKERNEL_H