~ubuntu-branches/ubuntu/wily/openwalnut/wily-proposed

//---------------------------------------------------------------------------

//

// 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 WMODULEONETOONECOMBINER_H

#define WMODULEONETOONECOMBINER_H

 

#include <string>

 

#include <boost/shared_ptr.hpp>

 

#include "../WModule.h"

#include "../WModuleCombiner.h"

#include "../WModuleCombinerTypes.h"

 

 

 

/**

 * Base class for all combiners which apply one connection between two connectors of two modules.

 */

class  WModuleOneToOneCombiner: public WModuleCombiner

{

public:

    /**

     * Creates a combiner which sets up the specified modules and prototype combination. Specifying a NULL pointer to the srcModule parameter

     * causes the combiner to only add the target module without any connections. This is especially useful for modules which do not provide any

     * input which must be connected. It is possible to specify prototypes here. The will get created upon apply.

     *

     *

     * \param target            the target container

     * \param srcModule         the module whose output should be connected with the prototypes input

     * \param srcConnector      the output connector of the module

     * \param targetModule      the module/prototype to use for connecting the module with

     * \param targetConnector   the input connector of the prototype to connect with srcConnector.

     */

    WModuleOneToOneCombiner( boost::shared_ptr< WModuleContainer > target,

                    boost::shared_ptr< WModule > srcModule, std::string srcConnector,

                    boost::shared_ptr< WModule > targetModule, std::string targetConnector );

 

    /**

     * Creates a combiner which sets up the specified modules and prototype combination. This constructor automatically uses the kernel's root

     * container as target container. Specifying a NULL pointer to the srcModule parameter

     * causes the combiner to only add the target module without any connections. This is especially useful for modules which do not provide any

     * input which must be connected. It is possible to specify prototypes here. The will get created upon apply.

     *

     * \param srcModule         the module whose output should be connected with the prototypes input

     * \param srcConnector      the output connector of the module

     * \param targetModule      the module/prototype to use for connecting the module with

     * \param targetConnector   the input connector of the prototype to connect with srcConnector.

     */

    WModuleOneToOneCombiner( boost::shared_ptr< WModule > srcModule, std::string srcConnector,

                    boost::shared_ptr< WModule > targetModule, std::string targetConnector );

 

    /**

     * Destructor.

     */

    virtual ~WModuleOneToOneCombiner();

 

    /**

     * Apply the internal module structure to the target container. Be aware, that this operation might take some time, as modules can be

     * connected only if they are "ready", which, at least with WMData modules, might take some time. It applies the loaded project file.

     */

    virtual void apply() = 0;

 

    /**

     * Gets the source module. This module's output connector is connected with the target.

     *

     * \return the source module.

     */

    boost::shared_ptr< WModule > getSrcModule() const;

 

    /**

     * The output connector of m_srcModule to connect with m_targetConnector.

     *

     * \return the source module's output connector.

     */

    std::string getSrcConnector() const;

 

    /**

     * The module/prototype to connect with m_srcModule.

     *

     * \return the target module prototype.

     */

    boost::shared_ptr< WModule > getTargetModule() const;

 

    /**

     * The input connector the target module to connect with m_srcConnector.

     *

     * \return the target module's input connector.

     */

    std::string getTargetConnector() const;

 

protected:

    /**

     * The source module to connect with the target

     */

    boost::shared_ptr< WModule > m_srcModule;

 

    /**

     * The output connector of m_srcModule to connect with m_targetConnector.

     */

    std::string m_srcConnector;

 

    /**

     * The module/prototype to connect with m_srcMdodule.

     */

    boost::shared_ptr< WModule > m_targetModule;

 

    /**

     * The input connector the target module to connect with m_srcConnector.

     */

    std::string m_targetConnector;

 

private:

};

 

#endif  // WMODULEONETOONECOMBINER_H