OpenWalnut
1.4.0
|
A wrapper for a module. More...
#include <WModuleWrapper.h>
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< WModule > | getModulePtr () |
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< WModule > | m_module |
A pointer to the module. |
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.
WModuleWrapper::WModuleWrapper | ( | boost::shared_ptr< WModule > | module | ) | [explicit] |
Destructor.
Definition at line 37 of file WModuleWrapper.cpp.
std::string WModuleWrapper::getDescription | ( | ) | const |
Get the description of the module.
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.
Definition at line 61 of file WModuleWrapper.cpp.
References m_module.
WInputConnectorWrapper WModuleWrapper::getInputConnector | ( | std::string const & | name | ) |
Get an input connector by name.
name | The name of the 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.
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.
Definition at line 41 of file WModuleWrapper.cpp.
References m_module.
WOutputConnectorWrapper WModuleWrapper::getOutputConnector | ( | std::string const & | name | ) |
Get an output connector by name.
name | The name of the 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.
Definition at line 56 of file WModuleWrapper.cpp.
References m_module.
boost::shared_ptr< WModule > WModuleWrapper::m_module [private] |
A pointer to the module.
Definition at line 112 of file WModuleWrapper.h.
Referenced by getDescription(), getInformationProperties(), getInputConnector(), getModulePtr(), getName(), getOutputConnector(), and getProperties().