← Back to branch summary

~ubuntu-branches/ubuntu/raring/openwalnut/raring

« back to all changes in this revision

Viewing changes to src/core/kernel/WModuleFactory.h

  • Committer: Package Import Robot
  • Author(s): Sebastian Eichelbaum
  • Date: 2012-12-12 11:26:32 UTC
  • mfrom: (3.1.1 sid)
  • Revision ID: package-import@ubuntu.com-20121212112632-xhiuwkxuz5h0idkh
Tags: 1.3.1+hg5849-1
* Minor changes compared to 1.3.0 but included several bug fixes.
* See http://www.openwalnut.org/versions/4

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/core/kernel/WModuleFactory.h
38
38
#include "WModule.h"
39
39
#include "WModuleLoader.h"
40
40
 
41
 
#include "WExportKernel.h"
 
41
 
42
42
 
43
43
/**
44
44
 * Class able to create a new copy of an arbitrary module. It uses the Factory and Prototype design pattern.
45
45
 */
46
 
class OWKERNEL_EXPORT WModuleFactory // NOLINT
 
46
class  WModuleFactory // NOLINT
47
47
{
48
48
friend class WModuleFactoryTest;
49
49
public:
50
 
 
51
50
    /**
52
51
     * For shortening: a type defining a shared set of WModule pointers.
53
52
     */
156
155
     * \param module the module to find the compatibles for.
157
156
     *
158
157
     * \note as the default parameter denotes, providing a NULL pointer (or calling the method without a parameter) returns the list of modules
159
 
     * which are compatible to every other module. In other words, it returns all modules without input connectors.
 
158
     * which are compatible to every other module. In other words, it returns all modules without input connectors. If the specified module is
 
159
     * not NULL, the modules without input are not listed.
160
160
     *
161
161
     * \return set of compatible combiners.
162
162
     */
165
165
    );
166
166
 
167
167
    /**
 
168
     * Creates a list of \ref WApplyCombiner for all modules known by the factory.
 
169
     *
 
170
     * \return list of apply combiner.
 
171
     */
 
172
    WCombinerTypes::WCompatiblesList getAllPrototypes();
 
173
 
 
174
    /**
168
175
     * This method uses a newly created instance of WModule and initializes it properly. After using this method, the module is
169
176
     * properly initialized and ready to be used.
170
177
     *
203
210
    bool checkPrototype( boost::shared_ptr< WModule > module, PrototypeSharedContainerType::ReadTicket ticket );
204
211
 
205
212
private:
206
 
 
207
213
    /**
208
214
     * Loader class managing dynamically loaded modules in OpenWalnut.
209
215
     */