hierarchyitem.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: hierarchyitem.h
//-----------------------------------------------------------------------------
// Project: Kactus 2
// Author: Antti Kamppi
// Date: 01.07.2011
//
// Description:
// Represents a single component in the library in hierarchy view.
//-----------------------------------------------------------------------------
 
#ifndef HIERARCHYITEM_H
#define HIERARCHYITEM_H
 
#include <IPXACTmodels/Catalog/Catalog.h>
#include <IPXACTmodels/Component/Component.h>
 
#include <IPXACTmodels/BusDefinition/BusDefinition.h>
#include <IPXACTmodels/AbstractionDefinition/AbstractionDefinition.h>
#include <IPXACTmodels/kactusExtensions/ApiDefinition.h>
#include <IPXACTmodels/kactusExtensions/ComDefinition.h>
#include <IPXACTmodels/Design/Design.h>
 
#include <IPXACTmodels/kactusExtensions/KactusAttribute.h>
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <QObject>
#include <QSharedPointer>
#include <QList>
#include <QMap>
 
class LibraryInterface;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API HierarchyItem : public QObject
{
    Q_OBJECT
 
public:

    enum ObjectType
    {
        ROOT = 0,
        COMPONENT,
        BUSDEFINITION,
        ABSDEFINITION,
        COMDEFINITION,
        APIDEFINITION,
        HW_DESIGN,
        SW_DESIGN,
        SYS_DESIGN,
        CATALOG
    };

    HierarchyItem(LibraryInterface* handler, HierarchyItem* parent, VLNV const& vlnv,
        KactusAttribute::Implementation implementation = KactusAttribute::KTS_IMPLEMENTATION_COUNT,
        QString const& viewName = QString());

    HierarchyItem(LibraryInterface* handler, QObject* parent);

    virtual ~HierarchyItem() = default;

    void createChild(const VLNV& vlnv);
 

    HierarchyItem* parent() const;

    VLNV const& getVLNV() const;

    HierarchyItem* child(int index) const;

    int row();

    int getNumberOfChildren() const;

    int getIndexOf(HierarchyItem* item);

    bool hasChildren() const;

    bool isValid() const;

    void setValidity(bool valid);

    bool contains(const VLNV& vlnv) const;

    void cleanUp();
    
    QSharedPointer<Component const> component() const;

    int referenceCount(const VLNV& vlnv) const;

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

    int removeItems(const VLNV& vlnv);

    QVector<HierarchyItem*> findItems(const VLNV& vlnv);

    void updateItems(const VLNV& vlnv);

    bool hasParent(const VLNV& vlnv);

    bool parentIsRoot() const;

    bool isRoot() const;

    bool isDuplicate() const;

    void setDuplicate(bool isDuplicate);

    QVector<VLNV> getVLNVs() const;

    void clear();

    bool isHierarchical() const;

    KactusAttribute::Implementation getImplementation() const;

    ObjectType type() const;

    void getChildren(QList<VLNV>& childList, const VLNV& owner) const;

    void getChildItems(QList<VLNV>& itemList) const;

    int instanceCount() const;

    QString getViewName() const;
 
signals:

    void noticeMessage(QString const& msg);

    void errorMessage(QString const& msg);
 
protected:

    int countInstances(const VLNV& componentVLNV);
 
private:
    HierarchyItem(const HierarchyItem& other);

    HierarchyItem& operator=(const HierarchyItem& other);

    bool hasChild(const VLNV& vlnv);

    void parseComponent(const VLNV& vlnv);
 
    void parseCatalog(VLNV const& vlnv);

    VLNV findDesignReference(QSharedPointer<View> view);

    void createChildItemForDesign(VLNV const& designVLNV,
        QString const& viewName);

    void parseBusDefinition(const VLNV& vlnv);

    void parseAbsDefinition(const VLNV& vlnv);

    void parseComDefinition(const VLNV& vlnv);

    void parseApiDefinition(const VLNV& vlnv);

    void parseDesign(const VLNV& vlnv, KactusAttribute::Implementation implementation, QString const& viewName);

    QVector<VLNV> getValidComponentsInDesign(QSharedPointer<Design const> design);

    bool isValidComponentInstanceVLNV(VLNV const& componentVLNV);
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    VLNV vlnv_;

    QSharedPointer<Component const> component_;

    LibraryInterface* library_;

    QVector<HierarchyItem*> childItems_;

    HierarchyItem* parentItem_;

    bool isValid_;

    bool isDuplicate_;

    ObjectType type_;

    QMap<VLNV, int> instanceCount_;

    QString viewName_;
};
 
#endif // HIERARCHYITEM_H