OpenWalnut
1.2.5
|
This is a simple class which forwards output data to output data connectors. More...
#include <WModuleOutputForwardData.h>
Public Member Functions | |
WModuleOutputForwardData (boost::shared_ptr< WModule > module, std::string name="", std::string description="") | |
Constructor. | |
virtual | ~WModuleOutputForwardData () |
Destructor. | |
virtual void | forward (boost::shared_ptr< WModuleConnector > from) |
Forward the output to the specified output. | |
virtual void | unforward (boost::shared_ptr< WModuleConnector > from) |
Remove the specified connector from the forwarding list. | |
Protected Member Functions | |
virtual void | inputNotifyDataChange (boost::shared_ptr< WModuleConnector >, boost::shared_ptr< WModuleConnector >) |
Gets called whenever a connected output updates its data. | |
Protected Attributes | |
boost::shared_ptr < WModuleInputData< T > > | m_in |
The output connector which collects data and distributes it to all connectors connected using the forwardTo() method. |
This is a simple class which forwards output data to output data connectors.
It itself is a output data connector and can be used as one, but also provides the possibility to forward data changes to other output data connectors.
Definition at line 43 of file WModuleOutputForwardData.h.
WModuleOutputForwardData< T >::WModuleOutputForwardData | ( | boost::shared_ptr< WModule > | module, |
std::string | name = "" , |
||
std::string | description = "" |
||
) | [inline] |
Constructor.
This creates a new output data connector which is able to forward data changes FROM other output data connectors.
module | the module which is owner of this connector. |
name | The name of this connector. |
description | Short description of this connector. |
Definition at line 54 of file WModuleOutputForwardData.h.
References WModuleOutputForwardData< T >::inputNotifyDataChange(), and WModuleOutputForwardData< T >::m_in.
virtual WModuleOutputForwardData< T >::~WModuleOutputForwardData | ( | ) | [inline, virtual] |
Destructor.
Definition at line 68 of file WModuleOutputForwardData.h.
virtual void WModuleOutputForwardData< T >::forward | ( | boost::shared_ptr< WModuleConnector > | from | ) | [inline, virtual] |
Forward the output to the specified output.
The specified output must be compatible with the template parameter of this output.
from | the output connector whose data should be forwarded. |
Definition at line 77 of file WModuleOutputForwardData.h.
References WModuleOutputForwardData< T >::m_in.
virtual void WModuleOutputForwardData< T >::inputNotifyDataChange | ( | boost::shared_ptr< WModuleConnector > | , |
boost::shared_ptr< WModuleConnector > | |||
) | [inline, protected, virtual] |
Gets called whenever a connected output updates its data.
In detail: it is a callback for m_in and waits simply forwards new data to this output instance.
Definition at line 103 of file WModuleOutputForwardData.h.
References WModuleOutputForwardData< T >::m_in, and WModuleOutputData< T >::updateData().
Referenced by WModuleOutputForwardData< T >::WModuleOutputForwardData().
virtual void WModuleOutputForwardData< T >::unforward | ( | boost::shared_ptr< WModuleConnector > | from | ) | [inline, virtual] |
Remove the specified connector from the forwarding list.
from | the output connector to be removed from forwarding list. |
Definition at line 87 of file WModuleOutputForwardData.h.
References WModuleOutputForwardData< T >::m_in.
boost::shared_ptr< WModuleInputData< T > > WModuleOutputForwardData< T >::m_in [protected] |
The output connector which collects data and distributes it to all connectors connected using the forwardTo() method.
Definition at line 97 of file WModuleOutputForwardData.h.
Referenced by WModuleOutputForwardData< T >::forward(), WModuleOutputForwardData< T >::inputNotifyDataChange(), WModuleOutputForwardData< T >::unforward(), and WModuleOutputForwardData< T >::WModuleOutputForwardData().