OpenWalnut
1.2.5
|
Base class for all combiners which apply one connection between two connectors of two modules. More...
#include <WApplyCombiner.h>
Public Member Functions | |
WApplyCombiner (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. | |
WApplyCombiner (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. | |
virtual | ~WApplyCombiner () |
Destructor. | |
virtual void | apply () |
Apply the internal module structure to the target container. | |
![]() | |
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. | |
WModuleOneToOneCombiner (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. | |
virtual | ~WModuleOneToOneCombiner () |
Destructor. | |
boost::shared_ptr< WModule > | getSrcModule () const |
Gets the source module. | |
std::string | getSrcConnector () const |
The output connector of m_srcModule to connect with m_targetConnector. | |
boost::shared_ptr< WModule > | getTargetModule () const |
The module/prototype to connect with m_srcModule. | |
std::string | getTargetConnector () const |
The input connector the target module to connect with m_srcConnector. | |
![]() | |
WModuleCombiner (boost::shared_ptr< WModuleContainer > target) | |
Creates an empty combiner. | |
WModuleCombiner () | |
Creates an empty combiner. | |
virtual | ~WModuleCombiner () |
Destructor. | |
virtual void | run () |
Run thread and call apply(). | |
![]() | |
WThreadedRunner () | |
Default constructor. | |
virtual | ~WThreadedRunner () |
Destructor. | |
void | run (THREADFUNCTION f) |
Run thread. | |
void | wait (bool requestFinish=false) |
Wait for the thread to be finished. | |
virtual void | requestStop () |
This method's purpose is to request a stop without waiting for it. |
Static Public Member Functions | |
template<typename T > | |
static WCombinerTypes::WOneToOneCombiners | createCombinerList (boost::shared_ptr< WModule > module1, boost::shared_ptr< WModule > module2) |
This method creates a list of possible combiners for connections between the specified modules. |
Additional Inherited Members | |
![]() | |
typedef boost::function< void(void) > | THREADFUNCTION |
Type used for simple thread functions. | |
![]() | |
virtual void | threadMain () |
Function that has to be overwritten for execution. | |
![]() | |
boost::shared_ptr< WModule > | m_srcModule |
The source module to connect with the target. | |
std::string | m_srcConnector |
The output connector of m_srcModule to connect with m_targetConnector. | |
boost::shared_ptr< WModule > | m_targetModule |
The module/prototype to connect with m_srcMdodule. | |
std::string | m_targetConnector |
The input connector the target module to connect with m_srcConnector. |
Base class for all combiners which apply one connection between two connectors of two modules.
Definition at line 46 of file WApplyCombiner.h.
WApplyCombiner::WApplyCombiner | ( | 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.
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.
target | the target container |
srcModule | the module whose output should be connected with the prototypes input |
srcConnector | the output connector of the module |
targetModule | the module/prototype to use for connecting the module with |
targetConnector | the input connector of the prototype to connect with srcConnector. |
Definition at line 31 of file WApplyCombiner.cpp.
WApplyCombiner::WApplyCombiner | ( | 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.
srcModule | the module whose output should be connected with the prototypes input |
srcConnector | the output connector of the module |
targetModule | the module/prototype to use for connecting the module with |
targetConnector | the input connector of the prototype to connect with srcConnector. |
Definition at line 38 of file WApplyCombiner.cpp.
|
virtual |
Destructor.
Definition at line 44 of file WApplyCombiner.cpp.
|
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 49 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.
|
inlinestatic |
This method creates a list of possible combiners for connections between the specified modules.
Both modules can be prototypes.
module1 | the first module |
module2 | the second module |
Definition at line 100 of file WApplyCombiner.h.