OpenWalnut  1.4.0
Public Member Functions | Static Public Member Functions
WApplyCombiner Class Reference

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

#include <WApplyCombiner.h>

+ Inheritance diagram for WApplyCombiner:

List of all members.

Public Member Functions

 WApplyCombiner (boost::shared_ptr< WModuleContainer > target, WModule::SPtr srcModule, std::string srcConnector, WModule::SPtr targetModule, std::string targetConnector)
 Creates a combiner which sets up the specified modules and prototype combination.
 WApplyCombiner (WModule::SPtr srcModule, std::string srcConnector, WModule::SPtr targetModule, std::string targetConnector)
 Creates a combiner which sets up the specified modules and prototype combination.
 WApplyCombiner (WModule::SPtr module)
 Creates a combiner which only adds the given module.
virtual ~WApplyCombiner ()
 Destructor.
virtual void apply ()
 Apply the internal module structure to the target container.

Static Public Member Functions

template<typename T >
static
WCombinerTypes::WOneToOneCombiners 
createCombinerList (WModule::SPtr module1, WModule::SPtr module2)
 This method creates a list of possible combiners for connections between the specified modules.

Detailed Description

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

Definition at line 46 of file WApplyCombiner.h.


Constructor & Destructor Documentation

WApplyCombiner::WApplyCombiner ( boost::shared_ptr< WModuleContainer target,
WModule::SPtr  srcModule,
std::string  srcConnector,
WModule::SPtr  targetModule,
std::string  targetConnector 
)

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.

Parameters:
targetthe target container
srcModulethe module whose output should be connected with the prototypes input
srcConnectorthe output connector of the module
targetModulethe module/prototype to use for connecting the module with
targetConnectorthe input connector of the prototype to connect with srcConnector.

Definition at line 31 of file WApplyCombiner.cpp.

WApplyCombiner::WApplyCombiner ( WModule::SPtr  srcModule,
std::string  srcConnector,
WModule::SPtr  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.

Parameters:
srcModulethe module whose output should be connected with the prototypes input
srcConnectorthe output connector of the module
targetModulethe module/prototype to use for connecting the module with
targetConnectorthe input connector of the prototype to connect with srcConnector.

Definition at line 38 of file WApplyCombiner.cpp.

Creates a combiner which only adds the given module.

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.

Parameters:
modulethe module to add

Definition at line 44 of file WApplyCombiner.cpp.

Destructor.

Definition at line 49 of file WApplyCombiner.cpp.


Member Function Documentation

void WApplyCombiner::apply ( ) [virtual]

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.

Implements WModuleOneToOneCombiner.

Definition at line 54 of file WApplyCombiner.cpp.

References wlog::error(), WModuleFactory::getModuleFactory(), WModuleFactory::isPrototype(), WModuleCombiner::m_container, WModuleOneToOneCombiner::m_srcConnector, WModuleOneToOneCombiner::m_srcModule, WModuleOneToOneCombiner::m_targetConnector, and WModuleOneToOneCombiner::m_targetModule.

template<typename T >
static WCombinerTypes::WOneToOneCombiners WApplyCombiner::createCombinerList ( WModule::SPtr  module1,
WModule::SPtr  module2 
) [inline, static]

This method creates a list of possible combiners for connections between the specified modules.

Both modules can be prototypes. This method lists only connections from module1's outputs to module2's inputs.

Parameters:
module1the first module
module2the second module
Returns:
the list of combiner for one-to-one connections

Definition at line 110 of file WApplyCombiner.h.


The documentation for this class was generated from the following files: