Grid/programs/Hadrons/Module.hpp

/*******************************************************************************
Grid physics library, www.github.com/paboyle/Grid 

Source file: programs/Hadrons/Module.hpp

Copyright (C) 2015

Author: Antonin Portelli <antonin.portelli@me.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

See the full license in the file "LICENSE" in the top level distribution 
directory.
*******************************************************************************/

#ifndef Hadrons_Module_hpp_
#define Hadrons_Module_hpp_

#include <Hadrons/Global.hpp>
#include <Hadrons/Environment.hpp>

BEGIN_HADRONS_NAMESPACE

// module registration macro
#define MODULE_REGISTER(mod)\
class mod##ModuleRegistrar\
{\
public:\
    mod##ModuleRegistrar(void)\
    {\
        ModuleFactory &modFac = ModuleFactory::getInstance();\
        modFac.registerBuilder(#mod, [&](const std::string name)\
                              {\
                                  return std::unique_ptr<mod>(new mod(name));\
                              });\
    }\
};\
static mod##ModuleRegistrar mod##ModuleRegistrarInstance;

/******************************************************************************
 *                                 Module                                     *
 ******************************************************************************/
class Module
{
public:
    // constructor
    Module(const std::string name);
    // destructor
    virtual ~Module(void) = default;
    // access
    std::string getName(void) const;
    // parse parameters
    virtual void parseParameters(XmlReader &reader, const std::string name) = 0;
    // dependency relation
    virtual std::vector<std::string> getInput(void) = 0;
    virtual std::vector<std::string> getOutput(void) = 0;
    // setup
    virtual void setup(Environment &env) {};
    // allocation
    virtual void allocate(Environment &env) {};
    // execution
    void operator()(Environment &env);
    virtual void execute(Environment &env) = 0;
private:
    std::string name_;
};

END_HADRONS_NAMESPACE

#endif // Hadrons_Module_hpp_