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.

Detailed Description

template<typename T>
class WModuleInputData< T >

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 48 of file WModuleInputData.h.

Member Typedef Documentation

template<typename T>

typedef boost::shared_ptr< WModuleInputData< T > > WModuleInputData< T >::PtrType

Pointer to this.

For convenience.

Reimplemented in WModuleInputForwardData< T >.

Definition at line 54 of file WModuleInputData.h.

template<typename T>

typedef WModuleInputData< T >& WModuleInputData< T >::RefType

Reference to this type.

Reimplemented in WModuleInputForwardData< T >.

Definition at line 59 of file WModuleInputData.h.

template<typename T>

typedef T WModuleInputData< T >::TransferType

Typedef to the contained transferable.

Reimplemented in WModuleInputForwardData< T >.

Definition at line 69 of file WModuleInputData.h.

template<typename T>

typedef WModuleInputData< T > WModuleInputData< T >::Type

Type of the connector.

Reimplemented in WModuleInputForwardData< T >.

Definition at line 64 of file WModuleInputData.h.

Constructor & Destructor Documentation

template<typename T>

WModuleInputData< T >::WModuleInputData	(	boost::shared_ptr< WModule >	module,
		std::string	name = `""`,
		std::string	description = `""`
	)		`[inline]`

Constructor.

Parameters:

module	the module which is owner of this connector.
name	The name of this connector.
description	Short description of this connector.

Definition at line 101 of file WModuleInputData.h.

template<typename T>

virtual WModuleInputData< T >::~WModuleInputData ( ) [inline, virtual]

Destructor.

Definition at line 110 of file WModuleInputData.h.

Member Function Documentation

template<typename T>

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.

Parameters:

con	the connector to check against.

Returns:: true if compatible.

Reimplemented from WModuleInputConnector.

Definition at line 165 of file WModuleInputData.h.

References WModuleInputConnector::connectable().

template<typename T >

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.

Parameters:

module	the module owning this instance
name	the name of this connector.
description	the description of this connector.

Returns:: the pointer to the created connector.

Reimplemented in WModuleInputForwardData< T >.

Definition at line 201 of file WModuleInputData.h.

template<typename T >

WModuleInputData< T >::PtrType WModuleInputData< T >::createAndAdd	(	boost::shared_ptr< WModule >	module,
		std::string	name = `""`,
		std::string	description = `""`
	)		`[static]`