PluginBase.h

#ifndef PLUGINBASE_H_
#define PLUGINBASE_H_
 
#include <any>
#include <list>
#include <map>
#include <string>
#include <functional>
 
#include "utils/FunctionWrapper.h"
 
class ParticleContainer;
class DomainDecompBase;
class Domain;
class XMLfileUnits;
 
 
class PluginBase {
public:
    PluginBase(){}
 
    virtual ~~PluginBase(){}
 
    virtual void init(ParticleContainer* particleContainer,
                            DomainDecompBase* domainDecomp, Domain* domain) = 0;
 
    virtual void readXML(XMLfileUnits& xmlconfig) = 0;
 
 
    virtual void beforeEventNewTimestep(
            ParticleContainer* particleContainer, DomainDecompBase* domainDecomp,
            unsigned long simstep
    ) {};
 
    virtual void beforeForces(
            ParticleContainer* particleContainer, DomainDecompBase* domainDecomp,
            unsigned long simstep
    ) {};
 
    virtual void siteWiseForces(
            ParticleContainer* particleContainer, DomainDecompBase* domainDecomp,
            unsigned long simstep
    ) {};
 
    virtual void afterForces(
            ParticleContainer* particleContainer, DomainDecompBase* domainDecomp,
            unsigned long simstep
    ) {};
 
 
    // make pure virtual?
    virtual void endStep(
            ParticleContainer* particleContainer, DomainDecompBase* domainDecomp,
            Domain* domain, unsigned long simstep) = 0;
 
    virtual void finish(ParticleContainer* particleContainer,
                              DomainDecompBase* domainDecomp, Domain* domain) = 0;
 
    virtual std::string getPluginName()  = 0;
 
    virtual void registerCallbacks(std::map<std::string, FunctionWrapper>& callbackMap) {
        // Empty by default.
    }
 
    virtual void accessAllCallbacks(const std::map<std::string, FunctionWrapper>& callbackMap) {
        // Empty by default.
    }
};
 
#endif /* PLUGINBASE_H */