OpenWalnut  1.2.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions
WDisconnectCombiner Class Reference

Combiner which disconnects the specified connection. More...

#include <WDisconnectCombiner.h>

+ Inheritance diagram for WDisconnectCombiner:

List of all members.

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.

Additional Inherited Members

- 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.
- Protected Attributes inherited from WModuleCombiner
boost::shared_ptr
< WModuleContainer
m_container
 The module container to use for the modules.
- Protected Attributes inherited from WThreadedRunner
boost::thread m_thread
 Thread instance.
WBoolFlag m_shutdownFlag
 Condition getting fired whenever the thread should quit.

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: