WModuleReadyEvent.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 WMODULEREADYEVENT_H
#define WMODULEREADYEVENT_H
 
#include <memory>
 
#include <QtCore/QEvent>
 
#include "core/kernel/WModule.h"
 
/**
 * Event signalling a new module has been associated with the root container in the kernel. Please note that it is possible that
 * the module is already marked as "ready" while processing this event due to the multithreading.
 */
class WModuleReadyEvent: public QEvent
{
public:
    /**
     * Creates a new event instance denoting that the specified module got associated in the root container.
     *
     * \param module the module that switched its state.
     */
    explicit WModuleReadyEvent( std::shared_ptr< WModule > module );
 
    /**
     * Destructor.
     */
    virtual ~WModuleReadyEvent();
 
    /**
     * Getter for the module that got associated.
     *
     * \return the module.
     */
    std::shared_ptr< WModule > getModule();
 
protected:
    /**
     * The module that got associated.
     */
    std::shared_ptr< WModule > m_module;
private:
};
 
#endif  // WMODULEREADYEVENT_H