OpenWalnut  1.4.0
Public Member Functions | Protected Member Functions | Private Attributes
WModuleOutputConnector Class Reference

Class implementing output connection functionality between modules. More...

#include <WModuleOutputConnector.h>

+ Inheritance diagram for WModuleOutputConnector:

List of all members.

Public Member Functions

 WModuleOutputConnector (boost::shared_ptr< WModule > module, std::string name="", std::string description="")
 Constructor.
virtual ~WModuleOutputConnector ()
 Destructor.
boost::signals2::connection subscribeSignal (MODULE_CONNECTOR_SIGNAL signal, t_GenericSignalHandlerType notifier)
 Connects (subscribes) a specified notify function with a signal this module instance is offering.
virtual bool connectable (boost::shared_ptr< WModuleConnector > con)
 Checks whether the specified connector is an input connector.
virtual boost::shared_ptr
< WPrototyped
getTransferPrototype ()=0
 Returns the prototype of the WTransferable used in this connector.
virtual const
boost::shared_ptr
< WTransferable
getRawData () const =0
 Gives back the currently set data as WTransferable.
virtual bool isInputConnector () const
 Returns true if this instance is an WModuleInputConnector.
virtual bool isOutputConnector () const
 Returns true if this instance is an WModuleOutputConnector.

Protected Member Functions

virtual void propagateDataChange ()
 Propagates the signal "DATA_CHANGED" to all connected items.

Private Attributes

t_GenericSignalType signal_DataChanged
 Signal fired whenever new data should be propagated.

Detailed Description

Class implementing output connection functionality between modules.

Definition at line 44 of file WModuleOutputConnector.h.


Constructor & Destructor Documentation

WModuleOutputConnector::WModuleOutputConnector ( boost::shared_ptr< WModule module,
std::string  name = "",
std::string  description = "" 
)

Constructor.

Parameters:
modulethe module which is owner of this connector.
nameThe name of this connector.
descriptionShort description of this connector.

Definition at line 35 of file WModuleOutputConnector.cpp.

Destructor.

Definition at line 41 of file WModuleOutputConnector.cpp.


Member Function Documentation

bool WModuleOutputConnector::connectable ( boost::shared_ptr< WModuleConnector con) [virtual]

Checks whether the specified connector is an input connector.

Parameters:
conthe connector to check against.
Returns:
true if compatible.

Implements WModuleConnector.

Reimplemented in WModuleOutputData< T >.

Definition at line 46 of file WModuleOutputConnector.cpp.

virtual const boost::shared_ptr< WTransferable > WModuleOutputConnector::getRawData ( ) const [pure virtual]

Gives back the currently set data as WTransferable.

Returns:
the data. If no data has been set: a NULL pointer is returned.

Implemented in WModuleOutputData< T >.

virtual boost::shared_ptr< WPrototyped > WModuleOutputConnector::getTransferPrototype ( ) [pure virtual]

Returns the prototype of the WTransferable used in this connector.

Returns:
the prototype of the transfered type.

Implemented in WModuleOutputData< T >.

bool WModuleOutputConnector::isInputConnector ( ) const [virtual]

Returns true if this instance is an WModuleInputConnector.

Returns:
true if castable to WModuleInputConnector.

Implements WModuleConnector.

Definition at line 75 of file WModuleOutputConnector.cpp.

Returns true if this instance is an WModuleOutputConnector.

Returns:
true if castable to WModuleOutputConnector.

Implements WModuleConnector.

Definition at line 80 of file WModuleOutputConnector.cpp.

void WModuleOutputConnector::propagateDataChange ( ) [protected, virtual]

Propagates the signal "DATA_CHANGED" to all connected items.

Definition at line 70 of file WModuleOutputConnector.cpp.

References signal_DataChanged.

Referenced by WModuleOutputData< T >::triggerUpdate().

boost::signals2::connection WModuleOutputConnector::subscribeSignal ( MODULE_CONNECTOR_SIGNAL  signal,
t_GenericSignalHandlerType  notifier 
) [virtual]

Connects (subscribes) a specified notify function with a signal this module instance is offering.

Exceptions:
WModuleSignalSubscriptionFailedthrown if the signal can't be connected.
Parameters:
signalthe signal to connect to.
notifierthe notifier function to bind.
Returns:
the connection object. Disconnect manually if not needed anymore.

Reimplemented from WModuleConnector.

Definition at line 57 of file WModuleOutputConnector.cpp.

References signal_DataChanged.


Member Data Documentation

t_GenericSignalType WModuleOutputConnector::signal_DataChanged [private]

Signal fired whenever new data should be propagated.

Represented by DATA_CHANGED enum- element.

Definition at line 128 of file WModuleOutputConnector.h.

Referenced by propagateDataChange(), and subscribeSignal().


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