WModuleWrapper Class Reference

A wrapper for a module. More...

#include <WModuleWrapper.h>

Collaboration diagram for WModuleWrapper:

Public Member Functions
	WModuleWrapper (std::shared_ptr< WModule > module)
	Constructor. More...
	~WModuleWrapper ()
	Destructor. More...
std::string	getName () const
	Get the name of the module. More...
std::string	getDescription () const
	Get the description of the module. More...
std::shared_ptr< WModule >	getModulePtr ()
	Returns the module pointer. More...
WPropertyGroupWrapper	getProperties ()
	Returns a WPropertyGroupWrapper containing the module's properties. More...
WPropertyGroupWrapper	getInformationProperties ()
	Returns a WPropertyGroupWrapper containing the module's info properties. More...
WInputConnectorWrapper	getInputConnector (std::string const &name)
	Get an input connector by name. More...
WOutputConnectorWrapper	getOutputConnector (std::string const &name)
	Get an output connector by name. More...

Private Attributes
std::shared_ptr< WModule >	m_module
	A pointer to the module. More...

Detailed Description

A wrapper for a module.

This is used to expose a part of the WModule functionality to script interpreters.

Definition at line 43 of file WModuleWrapper.h.

Constructor & Destructor Documentation

WModuleWrapper()

WModuleWrapper::WModuleWrapper ( std::shared_ptr< WModule >  module )

explicit

Constructor.

Parameters

module

The actual module.

Definition at line 32 of file WModuleWrapper.cpp.

~WModuleWrapper()

WModuleWrapper::~WModuleWrapper

(

)

Destructor.

Definition at line 37 of file WModuleWrapper.cpp.

Member Function Documentation

getDescription()

std::string WModuleWrapper::getDescription

(

)

const

Get the description of the module.

Returns

The description.

Definition at line 46 of file WModuleWrapper.cpp.

References m_module.

getInformationProperties()

WPropertyGroupWrapper WModuleWrapper::getInformationProperties

(

)

Returns a WPropertyGroupWrapper containing the module's info properties.

To be used in scripts.

Returns

The module's properties.

Definition at line 61 of file WModuleWrapper.cpp.

References m_module.

getInputConnector()

WInputConnectorWrapper WModuleWrapper::getInputConnector

(

std::string const &

name

)

Get an input connector by name.

Parameters

name	The name of the connector.

Returns

The retrieved connector.

Definition at line 66 of file WModuleWrapper.cpp.

References m_module.

getModulePtr()

std::shared_ptr< WModule > WModuleWrapper::getModulePtr

(

)

Returns the module pointer.

Useful to other wrapper classes.

Returns

The module pointer.

Definition at line 51 of file WModuleWrapper.cpp.

References m_module.

Referenced by WModuleContainerWrapper::remove().

Here is the caller graph for this function:

getName()

std::string WModuleWrapper::getName

(

)

const

Get the name of the module.

Returns

The name of the module.

Definition at line 41 of file WModuleWrapper.cpp.

References m_module.

getOutputConnector()

WOutputConnectorWrapper WModuleWrapper::getOutputConnector

(

std::string const &

name

)

Get an output connector by name.

Parameters

name	The name of the connector.

Returns

The retrieved connector.

Definition at line 71 of file WModuleWrapper.cpp.

References m_module.

getProperties()

WPropertyGroupWrapper WModuleWrapper::getProperties

(

)

Returns a WPropertyGroupWrapper containing the module's properties.

To be used in scripts.

Returns

The module's properties.

Definition at line 56 of file WModuleWrapper.cpp.

References m_module.

Member Data Documentation

m_module

std::shared_ptr< WModule > WModuleWrapper::m_module

private

A pointer to the module.

Definition at line 111 of file WModuleWrapper.h.

Referenced by getDescription(), getInformationProperties(), getInputConnector(), getModulePtr(), getName(), getOutputConnector(), and getProperties().

---

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

• WModuleWrapper.h
• WModuleWrapper.cpp