Class implementing output connection functionality between modules. More...
#include <WModuleOutputConnector.h>
Inheritance diagram for WModuleOutputConnector:
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. | |
Class implementing output connection functionality between modules.
Definition at line 44 of file WModuleOutputConnector.h.
| WModuleOutputConnector::WModuleOutputConnector | ( | boost::shared_ptr< WModule > | module, | |
| std::string | name = "", |
|||
| std::string | description = "" | |||
| ) |
Constructor.
| module | the module which is owner of this connector. | |
| name | The name of this connector. | |
| description | Short description of this connector. |
Definition at line 37 of file WModuleOutputConnector.cpp.
| WModuleOutputConnector::~WModuleOutputConnector | ( | ) | [virtual] |
Destructor.
Definition at line 43 of file WModuleOutputConnector.cpp.
| bool WModuleOutputConnector::connectable | ( | boost::shared_ptr< WModuleConnector > | con | ) | [virtual] |
Checks whether the specified connector is an input connector.
| con | the connector to check against. |
Implements WModuleConnector.
Reimplemented in WModuleOutputData< T >.
Definition at line 48 of file WModuleOutputConnector.cpp.
| virtual const boost::shared_ptr< WTransferable > WModuleOutputConnector::getRawData | ( | ) | const [pure virtual] |
Gives back the currently set data as WTransferable.
Implemented in WModuleOutputData< T >.
| virtual boost::shared_ptr< WPrototyped > WModuleOutputConnector::getTransferPrototype | ( | ) | [pure virtual] |
Returns the prototype of the WTransferable used in this connector.
Implemented in WModuleOutputData< T >.
| bool WModuleOutputConnector::isInputConnector | ( | ) | const [virtual] |
Returns true if this instance is an WModuleInputConnector.
Implements WModuleConnector.
Definition at line 77 of file WModuleOutputConnector.cpp.
| bool WModuleOutputConnector::isOutputConnector | ( | ) | const [virtual] |
Returns true if this instance is an WModuleOutputConnector.
Implements WModuleConnector.
Definition at line 82 of file WModuleOutputConnector.cpp.
| void WModuleOutputConnector::propagateDataChange | ( | ) | [protected, virtual] |
Propagates the signal "DATA_CHANGED" to all connected items.
Definition at line 72 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.
| WModuleSignalSubscriptionFailed | thrown if the signal can't be connected. |
| signal | the signal to connect to. | |
| notifier | the notifier function to bind. |
Reimplemented from WModuleConnector.
Definition at line 59 of file WModuleOutputConnector.cpp.
References signal_DataChanged.
t_GenericSignalType WModuleOutputConnector::signal_DataChanged [private] |
Signal fired whenever new data should be propagated.
Represented by DATA_CHANGED enum- element.
Definition at line 131 of file WModuleOutputConnector.h.
Referenced by propagateDataChange(), and subscribeSignal().
1.7.1
