IGeneratorPlugin.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: IGeneratorPlugin.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Joni-Matti Maatta
// Date: 27.6.2012
//
// Description:
// Interface for plugins that are used to generate content for different IP-XACT documents.
//-----------------------------------------------------------------------------
 
#ifndef IGENERATORPLUGIN_H
#define IGENERATORPLUGIN_H
 
#include "IPlugin.h"
 
#include <QSharedPointer>
#include <QIcon>
 
class Component;
class Design;
class DesignConfiguration;
class IPluginUtility;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class IGeneratorPlugin : public IPlugin
{
public:
    virtual ~IGeneratorPlugin() {}

    virtual QIcon getIcon() const = 0;

    virtual bool checkGeneratorSupport(QSharedPointer<Component const> component,
        QSharedPointer<Design const> design,
        QSharedPointer<DesignConfiguration const> designConfiguration) const = 0;

    virtual void runGenerator(IPluginUtility* utility, 
        QSharedPointer<Component> component,
        QSharedPointer<Design> design,
        QSharedPointer<DesignConfiguration> designConfiguration) = 0;
};
 
Q_DECLARE_INTERFACE(IGeneratorPlugin, "com.tut.Kactus2.IGeneratorPlugin/1.0")
 
//-----------------------------------------------------------------------------
 
#endif // IGENERATORPLUGIN_H