Base class for all combiners which apply one connection between two connectors of two modules. More...

#include <WApplyCombiner.h>

Inheritance diagram for WApplyCombiner:

Collaboration diagram for WApplyCombiner:

Public Member Functions
	WApplyCombiner (std::shared_ptr< WModuleContainer > target, WModule::SPtr srcModule, std::string srcConnector, WModule::SPtr targetModule, std::string targetConnector)
	Creates a combiner which sets up the specified modules and prototype combination. More...

	WApplyCombiner (WModule::SPtr srcModule, std::string srcConnector, WModule::SPtr targetModule, std::string targetConnector)
	Creates a combiner which sets up the specified modules and prototype combination. More...

	WApplyCombiner (WModule::SPtr module)
	Creates a combiner which only adds the given module. More...

virtual	~WApplyCombiner ()
	Destructor. More...

virtual void	apply ()
	Apply the internal module structure to the target container. More...

Public Member Functions inherited from 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. 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...

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

Static Public Member Functions
template<typename T >
static WCombinerTypes::WOneToOneCombiners	createCombinerList (WModule::SPtr module1, WModule::SPtr module2)
	This method creates a list of possible combiners for connections between the specified modules. 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...

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

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

Protected Attributes inherited from WModuleOneToOneCombiner
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...

Detailed Description

Base class for all combiners which apply one connection between two connectors of two modules.

Definition at line 45 of file WApplyCombiner.h.

Constructor & Destructor Documentation

◆ WApplyCombiner() [1/3]

WApplyCombiner::WApplyCombiner	(	std::shared_ptr< WModuleContainer >	target,
		WModule::SPtr	srcModule,
		std::string	srcConnector,
		WModule::SPtr	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.

Parameters

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() [2/3]

WApplyCombiner::WApplyCombiner	(	WModule::SPtr	srcModule,
		std::string	srcConnector,
		WModule::SPtr	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.

Parameters

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.

◆ WApplyCombiner() [3/3]

WApplyCombiner::WApplyCombiner ( WModule::SPtr module )

explicit

Creates a combiner which only adds the given module.

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.

Parameters

module the module to add

Definition at line 44 of file WApplyCombiner.cpp.

◆ ~WApplyCombiner()

WApplyCombiner::~WApplyCombiner ( )

virtual

Destructor.

Definition at line 49 of file WApplyCombiner.cpp.

Member Function Documentation

◆ apply()

void WApplyCombiner::apply ( )

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

Definition at line 54 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.

Here is the call graph for this function:

◆ createCombinerList()

template<typename T >

static WCombinerTypes::WOneToOneCombiners WApplyCombiner::createCombinerList	(	WModule::SPtr	module1,
		WModule::SPtr	module2
	)

inlinestatic

This method creates a list of possible combiners for connections between the specified modules.

Both modules can be prototypes. This method lists only connections from module1's outputs to module2's inputs.

Parameters

module1	the first module
module2	the second module

Returns: the list of combiner for one-to-one connections

Definition at line 109 of file WApplyCombiner.h.

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WApplyCombiner() [1/3]

◆ WApplyCombiner() [2/3]

◆ WApplyCombiner() [3/3]

◆ ~WApplyCombiner()

Member Function Documentation

◆ apply()

◆ createCombinerList()