OpenWalnut  1.3.1
Public Member Functions | List of all members
WDisconnectCombiner Class Reference

Combiner which disconnects the specified connection. More...

#include <WDisconnectCombiner.h>

+ Inheritance diagram for WDisconnectCombiner:

Public Member Functions

 WDisconnectCombiner (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 disconnects the specified connection.
 WDisconnectCombiner (boost::shared_ptr< WModule > srcModule, std::string srcConnector, boost::shared_ptr< WModule > targetModule, std::string targetConnector)
 Creates a combiner which disconnects the specified connection.
 WDisconnectCombiner (boost::shared_ptr< WModuleConnector > srcConnector, boost::shared_ptr< WModuleConnector > targetConnector)
 Creates a combiner which disconnects the specified connection.
virtual ~WDisconnectCombiner ()
 Destructor.
virtual void apply ()
 Disconnects the specified connection.
- Public Member Functions inherited from WModuleOneToOneCombiner
 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< WModulegetSrcModule () const
 Gets the source module.
std::string getSrcConnector () const
 The output connector of m_srcModule to connect with m_targetConnector.
boost::shared_ptr< WModulegetTargetModule () const
 The module/prototype to connect with m_srcModule.
std::string getTargetConnector () const
 The input connector the target module to connect with m_srcConnector.
- Public Member Functions inherited from WModuleCombiner
 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().
- Public Member Functions inherited from WThreadedRunner
 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.
virtual boost::signals2::connection subscribeSignal (THREAD_SIGNAL signal, t_ThreadErrorSignalHandlerType notifier)
 Connects a specified notify function with a signal this thread instance is offering.
const WBoolFlagisCrashed () const
 Checks whether this thread has been crashed.
const std::string & getCrashMessage () const
 Get the message of the exception finally causing the crash.
void setThreadName (std::string name)
 Set the name of the thread.
std::string getThreadName () const
 Returns the current thread name.

Additional Inherited Members

- Public Types inherited from WThreadedRunner
typedef boost::function< void(void) > THREADFUNCTION
 Type used for simple thread functions.
- Static Public Member Functions inherited from WThreadedRunner
static void setThisThreadName (std::string name)
 Static function to set the name of the calling thread.
- Protected Member Functions inherited from WModuleCombiner
virtual void threadMain ()
 Function that has to be overwritten for execution.
- Protected Attributes inherited from WModuleOneToOneCombiner
boost::shared_ptr< WModulem_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< WModulem_targetModule
 The module/prototype to connect with m_srcMdodule.
std::string m_targetConnector
 The input connector the target module to connect with m_srcConnector.

Detailed Description

Combiner which disconnects the specified connection.

Definition at line 46 of file WDisconnectCombiner.h.

Constructor & Destructor Documentation

WDisconnectCombiner::WDisconnectCombiner ( 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 disconnects the specified connection.

If the specified connection does not exist (anymore), nothing will happen.

Parameters
targetthe target container
srcModulethe module whose connector should be disconnected
srcConnectorthe srcModule connector to disconnect
targetModulethe module whose connector should be disconnected from srcConnector
targetConnectorthe targetModule connector to disconnect.

Definition at line 29 of file WDisconnectCombiner.cpp.

WDisconnectCombiner::WDisconnectCombiner ( boost::shared_ptr< WModule srcModule,
std::string  srcConnector,
boost::shared_ptr< WModule targetModule,
std::string  targetConnector 
)

Creates a combiner which disconnects the specified connection.

If the specified connection does not exist (anymore), nothing will happen.

Parameters
srcModulethe module whose connector should be disconnected
srcConnectorthe srcModule connector to disconnect
targetModulethe module whose connector should be disconnected from srcConnector
targetConnectorthe targetModule connector to disconnect.

Definition at line 36 of file WDisconnectCombiner.cpp.

WDisconnectCombiner::WDisconnectCombiner ( boost::shared_ptr< WModuleConnector srcConnector,
boost::shared_ptr< WModuleConnector targetConnector 
)

Creates a combiner which disconnects the specified connection.

If the specified connection does not exist (anymore), nothing will happen.

Parameters
srcConnectorconnector 1
targetConnectorconnector 2

Definition at line 42 of file WDisconnectCombiner.cpp.

WDisconnectCombiner::~WDisconnectCombiner ( )
virtual

Destructor.

Definition at line 48 of file WDisconnectCombiner.cpp.

Member Function Documentation

void WDisconnectCombiner::apply ( )
virtual

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