OpenWalnut  1.4.0
Public Member Functions | Private Attributes
WModuleWrapper Class Reference

A wrapper for a module. More...

#include <WModuleWrapper.h>

List of all members.

Public Member Functions

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

Private Attributes

boost::shared_ptr< WModulem_module
 A pointer to the module.

Detailed Description

A wrapper for a module.

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

Definition at line 44 of file WModuleWrapper.h.


Constructor & Destructor Documentation

WModuleWrapper::WModuleWrapper ( boost::shared_ptr< WModule module) [explicit]

Constructor.

Parameters:
moduleThe actual module.

Definition at line 32 of file WModuleWrapper.cpp.

Destructor.

Definition at line 37 of file WModuleWrapper.cpp.


Member Function Documentation

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.

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.

Get an input connector by name.

Parameters:
nameThe name of the connector.
Returns:
The retrieved connector.

Definition at line 66 of file WModuleWrapper.cpp.

References m_module.

boost::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().

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.

Get an output connector by name.

Parameters:
nameThe name of the connector.
Returns:
The retrieved connector.

Definition at line 71 of file WModuleWrapper.cpp.

References m_module.

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

boost::shared_ptr< WModule > WModuleWrapper::m_module [private]

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