OpenWalnut
1.5.0dev
|
Base class for all combiners which apply one connection between two connectors of two modules. More...
#include <WModuleOneToOneCombiner.h>
Public Member Functions | |
WModuleOneToOneCombiner (std::shared_ptr< WModuleContainer > target, std::shared_ptr< WModule > srcModule, std::string srcConnector, std::shared_ptr< WModule > targetModule, std::string targetConnector) | |
Creates a combiner which sets up the specified modules and prototype combination. More... | |
WModuleOneToOneCombiner (std::shared_ptr< WModule > srcModule, std::string srcConnector, std::shared_ptr< WModule > targetModule, std::string targetConnector) | |
Creates a combiner which sets up the specified modules and prototype combination. More... | |
virtual | ~WModuleOneToOneCombiner () |
Destructor. More... | |
virtual void | apply ()=0 |
Apply the internal module structure to the target container. More... | |
std::shared_ptr< WModule > | getSrcModule () const |
Gets the source module. More... | |
std::string | getSrcConnector () const |
The output connector of m_srcModule to connect with m_targetConnector. More... | |
std::shared_ptr< WModule > | getTargetModule () const |
The module/prototype to connect with m_srcModule. More... | |
std::string | getTargetConnector () const |
The input connector the target module to connect with m_srcConnector. More... | |
Public Member Functions inherited from WModuleCombiner | |
WModuleCombiner (std::shared_ptr< WModuleContainer > target) | |
Creates an empty combiner. More... | |
WModuleCombiner () | |
Creates an empty combiner. More... | |
virtual | ~WModuleCombiner () |
Destructor. More... | |
virtual void | run () |
Run thread and call apply(). More... | |
Public Member Functions inherited from WThreadedRunner | |
WThreadedRunner () | |
Default constructor. More... | |
virtual | ~WThreadedRunner () |
Destructor. More... | |
void | run (THREADFUNCTION f) |
Run thread. More... | |
void | wait (bool requestFinish=false) |
Wait for the thread to be finished. More... | |
virtual void | requestStop () |
This method's purpose is to request a stop without waiting for it. More... | |
virtual boost::signals2::connection | subscribeSignal (THREAD_SIGNAL signal, t_ThreadErrorSignalHandlerType notifier) |
Connects a specified notify function with a signal this thread instance is offering. More... | |
const WBoolFlag & | isCrashed () const |
Checks whether this thread has been crashed. More... | |
const std::string & | getCrashMessage () const |
Get the message of the exception finally causing the crash. More... | |
void | setThreadName (std::string name) |
Set the name of the thread. More... | |
std::string | getThreadName () const |
Returns the current thread name. More... | |
Protected Attributes | |
std::shared_ptr< WModule > | m_srcModule |
The source module to connect with the target. More... | |
std::string | m_srcConnector |
The output connector of m_srcModule to connect with m_targetConnector. More... | |
std::shared_ptr< WModule > | m_targetModule |
The module/prototype to connect with m_srcMdodule. More... | |
std::string | m_targetConnector |
The input connector the target module to connect with m_srcConnector. More... | |
Protected Attributes inherited from WModuleCombiner | |
std::shared_ptr< WModuleContainer > | m_container |
The module container to use for the modules. More... | |
Protected Attributes inherited from WThreadedRunner | |
boost::thread | m_thread |
Thread instance. More... | |
WBoolFlag | m_shutdownFlag |
Condition getting fired whenever the thread should quit. More... | |
WBoolFlag | m_isCrashed |
True whenever an exception is thrown during threadMain. More... | |
std::string | m_crashMessage |
The crash message. More... | |
Additional Inherited Members | |
Public Types inherited from WThreadedRunner | |
typedef std::shared_ptr< WThreadedRunner > | SPtr |
Abbreviation to a shared_ptr to this type. More... | |
typedef std::shared_ptr< const WThreadedRunner > | ConstSPtr |
Abbreviation to a const shared_ptr to this type. More... | |
typedef boost::function< void(void) > | THREADFUNCTION |
Type used for simple thread functions. More... | |
Static Public Member Functions inherited from WThreadedRunner | |
static void | setThisThreadName (std::string name) |
Static function to set the name of the calling thread. More... | |
Protected Member Functions inherited from WModuleCombiner | |
virtual void | threadMain () |
Function that has to be overwritten for execution. More... | |
Protected Member Functions inherited from WThreadedRunner | |
virtual void | notifyStop () |
Gets called when the thread should be stopped. More... | |
void | yield () const |
Give remaining execution timeslice to another thread. More... | |
void | sleep (const int32_t t) const |
Sets thread asleep. More... | |
void | msleep (const int32_t t) const |
Sets thread asleep. More... | |
void | waitForStop () |
Let the thread sleep until a stop request was given. More... | |
virtual void | onThreadException (const WException &e) |
This method is called if an exception was caught, which came from the custom thread code. More... | |
void | handleDeadlyException (const WException &e, std::string sender="WThreadedRunner") |
Handle the specified exception which was not caught in the thread, which basically means the thread has crashed. More... | |
Base class for all combiners which apply one connection between two connectors of two modules.
Definition at line 41 of file WModuleOneToOneCombiner.h.
WModuleOneToOneCombiner::WModuleOneToOneCombiner | ( | std::shared_ptr< WModuleContainer > | target, |
std::shared_ptr< WModule > | srcModule, | ||
std::string | srcConnector, | ||
std::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 30 of file WModuleOneToOneCombiner.cpp.
WModuleOneToOneCombiner::WModuleOneToOneCombiner | ( | std::shared_ptr< WModule > | srcModule, |
std::string | srcConnector, | ||
std::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 41 of file WModuleOneToOneCombiner.cpp.
|
virtual |
Destructor.
Definition at line 51 of file WModuleOneToOneCombiner.cpp.
|
pure 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 WDataModule modules, might take some time. It applies the loaded project file.
Implements WModuleCombiner.
Implemented in WDisconnectCombiner, and WApplyCombiner.
std::string WModuleOneToOneCombiner::getSrcConnector | ( | ) | const |
The output connector of m_srcModule to connect with m_targetConnector.
Definition at line 61 of file WModuleOneToOneCombiner.cpp.
References m_srcConnector.
std::shared_ptr< WModule > WModuleOneToOneCombiner::getSrcModule | ( | ) | const |
Gets the source module.
This module's output connector is connected with the target.
Definition at line 56 of file WModuleOneToOneCombiner.cpp.
References m_srcModule.
std::string WModuleOneToOneCombiner::getTargetConnector | ( | ) | const |
The input connector the target module to connect with m_srcConnector.
Definition at line 71 of file WModuleOneToOneCombiner.cpp.
References m_targetConnector.
std::shared_ptr< WModule > WModuleOneToOneCombiner::getTargetModule | ( | ) | const |
The module/prototype to connect with m_srcModule.
Definition at line 66 of file WModuleOneToOneCombiner.cpp.
References m_targetModule.
|
protected |
The output connector of m_srcModule to connect with m_targetConnector.
Definition at line 122 of file WModuleOneToOneCombiner.h.
Referenced by WApplyCombiner::apply(), WDisconnectCombiner::apply(), and getSrcConnector().
|
protected |
The source module to connect with the target.
Definition at line 117 of file WModuleOneToOneCombiner.h.
Referenced by WApplyCombiner::apply(), WDisconnectCombiner::apply(), and getSrcModule().
|
protected |
The input connector the target module to connect with m_srcConnector.
Definition at line 132 of file WModuleOneToOneCombiner.h.
Referenced by WApplyCombiner::apply(), WDisconnectCombiner::apply(), and getTargetConnector().
|
protected |
The module/prototype to connect with m_srcMdodule.
Definition at line 127 of file WModuleOneToOneCombiner.h.
Referenced by WApplyCombiner::apply(), WDisconnectCombiner::apply(), and getTargetModule().