Class offering an instantiate-able data connection between modules. More...
#include <WModuleInputData.h>
Inheritance diagram for WModuleInputData< T >:
Public Types | |
| typedef boost::shared_ptr < WModuleInputData< T > > | PtrType |
| Pointer to this. | |
| typedef WModuleInputData< T > & | RefType |
| Reference to this type. | |
| typedef WModuleInputData< T > | Type |
| Type of the connector. | |
| typedef T | TransferType |
| Typedef to the contained transferable. | |
Public Member Functions | |
| WModuleInputData (boost::shared_ptr< WModule > module, std::string name="", std::string description="") | |
| Constructor. | |
| virtual | ~WModuleInputData () |
| Destructor. | |
| virtual void | disconnect (boost::shared_ptr< WModuleConnector > con, bool removeFromOwnList=true) |
| Disconnects this connector if connected. | |
| const boost::shared_ptr< T > | getData (bool reset=true) |
| Gives the currently set data and resets the update flag. | |
| virtual bool | connectable (boost::shared_ptr< WModuleConnector > con) |
| Checks whether the specified connector is an input connector and compatible with T. | |
Static Public Member Functions | |
| static PtrType | create (boost::shared_ptr< WModule > module, std::string name="", std::string description="") |
| Convenience method to create a new instance of this in data connector with proper type. | |
| static PtrType | createAndAdd (boost::shared_ptr< WModule > module, std::string name="", std::string description="") |
| Convenience method to create a new instance of this in data connector with proper type and add it to the list of connectors of the specified module. | |
Private Attributes | |
| bool | m_disconnecting |
| If true, the returned data will be NULL. | |
Class offering an instantiate-able data connection between modules.
Due to is template style it is possible to bind nearly arbitrary data.
Definition at line 49 of file WModuleInputData.h.
| typedef boost::shared_ptr< WModuleInputData< T > > WModuleInputData< T >::PtrType |
Pointer to this.
For convenience.
Reimplemented in WModuleInputForwardData< T >.
Definition at line 55 of file WModuleInputData.h.
| typedef WModuleInputData< T >& WModuleInputData< T >::RefType |
Reference to this type.
Reimplemented in WModuleInputForwardData< T >.
Definition at line 60 of file WModuleInputData.h.
| typedef T WModuleInputData< T >::TransferType |
Typedef to the contained transferable.
Reimplemented in WModuleInputForwardData< T >.
Definition at line 70 of file WModuleInputData.h.
| typedef WModuleInputData< T > WModuleInputData< T >::Type |
Type of the connector.
Reimplemented in WModuleInputForwardData< T >.
Definition at line 65 of file WModuleInputData.h.
| WModuleInputData< T >::WModuleInputData | ( | boost::shared_ptr< WModule > | module, | |
| std::string | name = "", |
|||
| std::string | description = "" | |||
| ) | [inline] |
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 102 of file WModuleInputData.h.
| virtual WModuleInputData< T >::~WModuleInputData | ( | ) | [inline, virtual] |
Destructor.
Definition at line 111 of file WModuleInputData.h.
| virtual bool WModuleInputData< T >::connectable | ( | boost::shared_ptr< WModuleConnector > | con | ) | [inline, virtual] |
Checks whether the specified connector is an input connector and compatible with T.
| con | the connector to check against. |
Reimplemented from WModuleInputConnector.
Definition at line 166 of file WModuleInputData.h.
References WModuleInputConnector::connectable().
| WModuleInputData< T >::PtrType WModuleInputData< T >::create | ( | boost::shared_ptr< WModule > | module, | |
| std::string | name = "", |
|||
| std::string | description = "" | |||
| ) | [static] |
Convenience method to create a new instance of this in data connector with proper type.
| module | the module owning this instance | |
| name | the name of this connector. | |
| description | the description of this connector. |
Reimplemented in WModuleInputForwardData< T >.
Definition at line 204 of file WModuleInputData.h.
Referenced by WModuleInputData< T >::createAndAdd().
| WModuleInputData< T >::PtrType WModuleInputData< T >::createAndAdd | ( | boost::shared_ptr< WModule > | module, | |
| std::string | name = "", |
|||
| std::string | description = "" | |||
| ) | [static] |
Convenience method to create a new instance of this in data connector with proper type and add it to the list of connectors of the specified module.
| module | the module owning this instance | |
| name | the name of this connector. | |
| description | the description of this connector. |
Reimplemented in WModuleInputForwardData< T >.
Definition at line 213 of file WModuleInputData.h.
References WModuleInputData< T >::create().
| void WModuleInputData< T >::disconnect | ( | boost::shared_ptr< WModuleConnector > | con, | |
| bool | removeFromOwnList = true | |||
| ) | [virtual] |
Disconnects this connector if connected.
If it is not connected: nothing happens.
| con | the connector to disconnect. | |
| removeFromOwnList | if true the specified connection is also removed from the own connection list. If false it won't. |
Reimplemented from WModuleConnector.
Definition at line 196 of file WModuleInputData.h.
References WModuleInputData< T >::m_disconnecting.
| const boost::shared_ptr< T > WModuleInputData< T >::getData | ( | bool | reset = true |
) | [inline] |
Gives the currently set data and resets the update flag.
| reset | reset the flag of updated() if true (default). |
Definition at line 130 of file WModuleInputData.h.
References WModuleInputConnector::handledUpdate(), WModuleConnector::m_connected, WModuleConnector::m_connectionListLock, and WModuleInputData< T >::m_disconnecting.
bool WModuleInputData< T >::m_disconnecting [private] |
If true, the returned data will be NULL.
Needed because disconnection process is based on multiple steps.
Definition at line 183 of file WModuleInputData.h.
Referenced by WModuleInputData< T >::disconnect(), and WModuleInputData< T >::getData().
1.7.1
