LibraryInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: libraryinterface.h
//-----------------------------------------------------------------------------
// Project: Kactus 2
// Author: Antti Kamppi
// Date: 22.02.2011
//
// Description:
// LibraryInterface defines an interface to operate the IP-XACT-library.
//-----------------------------------------------------------------------------
 
#ifndef LIBRARYINTERFACE_H
#define LIBRARYINTERFACE_H
 
#include <IPXACTmodels/common/VLNV.h>
 
#include <QObject>
#include <QSharedPointer>
 
class Design;
class LibraryItem;
class Document;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class LibraryInterface
{
 
public:

    virtual QSharedPointer<Document> getModel(VLNV const& vlnv) = 0;

    template <class T>
    QSharedPointer<T> getModel(VLNV const& vlnv)
    {
        return getModel(vlnv).dynamicCast<T>();
    }

    virtual QSharedPointer<Document const> getModelReadOnly(VLNV const& vlnv) = 0;

    template <class T>
    QSharedPointer<T const> getModelReadOnly(VLNV const& vlnv)
    {
        return getModelReadOnly(vlnv).dynamicCast<T const>();
    }

    virtual bool contains(VLNV const& vlnv) const = 0;

    virtual QList<VLNV> getAllVLNVs() const = 0;

    virtual const QString getPath(VLNV const& vlnv) const = 0;

    virtual QString getDirectoryPath(VLNV const& vlnv) const = 0;

    virtual bool writeModelToFile(QString const& path, QSharedPointer<Document> model) = 0;

    virtual bool writeModelToFile(QSharedPointer<Document> model) = 0;

    virtual void searchForIPXactFiles() = 0;

    virtual void getNeededVLNVs(VLNV const& vlnv, QList<VLNV>& list) = 0;

    virtual void getDependencyFiles(VLNV const& vlnv, QStringList& list) = 0;

    virtual LibraryItem const* getTreeRoot() const = 0;

    virtual VLNV::IPXactType getDocumentType(VLNV const& vlnv) = 0;

    virtual int referenceCount(VLNV const& vlnv) const = 0;

    virtual int getOwners(QList<VLNV>& list, VLNV const& vlnvToSearch) const = 0;

    virtual int getChildren(QList<VLNV>& list, VLNV const& vlnvToSearch) const = 0;

    virtual VLNV getDesignVLNV(VLNV const& hierarchyRef) = 0;

    virtual QSharedPointer<Design> getDesign(VLNV const& hierarchyRef) = 0;

    virtual bool isValid(VLNV const& vlnv) = 0;
 
public slots:

    virtual void onCheckLibraryIntegrity() = 0;

    virtual void onEditItem(VLNV const& vlnv) = 0;

    virtual void onOpenDesign(VLNV const& vlnv, QString const& viewName) = 0;

    virtual void removeObject(VLNV const& vlnv) = 0;

    virtual void removeObjects(const QList<VLNV>& vlnvList) = 0;

    virtual void beginSave() = 0;

    virtual void endSave() = 0;
 
signals:

    void openDesign(VLNV const& vlnv, QString const& viewName);

    void openBus(VLNV const& busDefVLNV, VLNV const& absDefVLNV, bool disableBusDef);

    void openComponent(VLNV const& vlnv);

    void createAbsDef(VLNV const& busDefVLNV, QString const& directory, bool disableBusDef);

    void itemSelected(VLNV const& vlnv);

    void openSystemDesign(VLNV const& vlnv);

    void openPlatformComponent(VLNV const& vlnv);
 
};
 
#endif // LIBRARYINTERFACE_H