rrPlugin.h

Go to the documentation of this file.

#ifndef rrPluginH
#define rrPluginH
#include <sstream>
#include <string>
#include "rrPluginsAPIExporter.h"
#include "rrPluginsAPISettings.h"
#include "rrCapabilities.h"

namespace rr
{
class RoadRunner;
}

namespace rrp
{
using namespace rr;
using std::string;
class PluginManager;

typedef void    (event_cc *PluginEvent)(void* data1, void* data2);

class PLUGINS_API_DECLSPEC Plugin
{
    friend PluginManager;
    public:
                                        Plugin( const string& name = gEmptyString,
                                                const string& cat = gNoneString,
                                                RoadRunner* aRR = NULL,
                                                const string& language = gNoneString,
                                                const PluginManager* pm = NULL);

        virtual                        ~Plugin();

        string                          getName();

        string                          getLibraryName();

        string                          getAuthor();

        string                          getCategory();

        string                          getVersion();

        string                          getCopyright();


        RoadRunner*                     getRoadRunnerInstance();


        virtual string                  getInfo();

        virtual string                  getExtendedInfo();

        virtual unsigned char*          getManualAsPDF() const;

        virtual unsigned int            getPDFManualByteSize();

        Parameters*                     getParameters(); //Each capability has a set of parameters

        StringList                      getParameterNames(); //Each capability has a set of parameters

        string                          getPluginPropertiesAsXML(); 

        PluginParameter*                getParameter(const string& param, const string& capability = "");

        PluginParameter*                getParameter(const string& param, Capability& capability);

        bool                            setParameter(const string& nameOf, const char* value);

        bool                            setParameter(const string& nameOf, const char* value, Capability& capability);


        void                            terminate();

        bool                            isBeingTerminated();

        bool                            wasTerminated();

        virtual bool                    isWorking();

        bool                            assignRoadRunnerInstance(RoadRunner* rr);

        virtual bool                    assignOnStartedEvent(PluginEvent pluginStarted, void* userData1 = NULL, void* userData2 = NULL);

        virtual bool                    assignOnProgressEvent(PluginEvent pluginsProgress, void* userData1 = NULL, void* userData2 = NULL);

        virtual bool                    assignOnFinishedEvent(PluginEvent pluginsFinished, void* userData1 = NULL, void* userData2 = NULL);

        virtual string                  getResult();

        virtual bool                    resetPlugin();

        virtual bool                    assignInput(void* data);

        virtual string                  getStatus();

        virtual string                  getImplementationLanguage() = 0;

        virtual bool                    execute(bool inAThread = false) = 0;

    protected:                          
        string                          mName;

        string                          mLibraryName;

        string                          mAuthor;

        string                          mCategory;

        string                          mVersion;

        string                          mCopyright;

        string                          mImplementationLanguage;

        bool                            mTerminate;

        bool                            mIsWorking;

        RoadRunner                     *mRR;

        const PluginManager            *mPM;

        void                            setLibraryName(const string& libName);

        PluginEvent                     mWorkStartedEvent;

        PluginEvent                     mWorkProgressEvent;

        PluginEvent                     mWorkFinishedEvent;

        void                           *mWorkStartedData1;

        void                           *mWorkStartedData2;

        void                           *mWorkProgressData1;

        void                           *mWorkProgressData2;

        void                           *mWorkFinishedData1;

        void                           *mWorkFinishedData2;

        Capabilities                    mCapabilities;

        void                           *mClientData;

};

}

#endif