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< 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.
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< 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.
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:

target	the target container
srcModule	the module whose connector should be disconnected
srcConnector	the srcModule connector to disconnect
targetModule	the module whose connector should be disconnected from srcConnector
targetConnector	the 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:

srcModule	the module whose connector should be disconnected
srcConnector	the srcModule connector to disconnect
targetModule	the module whose connector should be disconnected from srcConnector
targetConnector	the 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:

srcConnector	connector 1
targetConnector	connector 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

Disconnects the specified connection.

Implements WModuleOneToOneCombiner.

Definition at line 53 of file WDisconnectCombiner.cpp.

References WModuleOneToOneCombiner::m_srcConnector, WModuleOneToOneCombiner::m_srcModule, WModuleOneToOneCombiner::m_targetConnector, and WModuleOneToOneCombiner::m_targetModule.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation